Cisco-IOS-XR-ipv4-bgp-cfg API API Reference

API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
   Key  Mandatory  Optional

Paths

INSTANCE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/

Update operation of resource: instance

instancebody object

instance-name: string
in path

ID of instance-name

Request Content-Types: application/json
Request Example
{      {          {
            
"bgp-running": "null", Enable BGP. Deletion of this object causes\ndeletion of all the objects under FourByteAS\nassociated with this object.
{
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", Instance Name. For Default instance use -\ndefault
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
range: "0..127"
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] },
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"mvpn": "null", Connect to PIM/PIM6
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
{
"addrress": "string", Address
"as": "integer", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"minimum": "integer", Minimum Prefix Length
"maximum": "integer" Maximum Prefix Length
} ] },
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"update-error-handling-extended-ibgp": "null", Inbound update extended error-handling for\nIBGP neighbors
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"install-diversion": "null", Install diversion path to RIB/CEF
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"attribute-filter-group-name": "string", Group name
{
"attribute-start": "string", Start of attribute range
"attribute-end": "string", End of attribute range
"filter-action": "string" Filtering action
} ] } } ] },
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"update-limit-process": "integer", Upper bound on update generation transient\nmemory usage for the process
range: "16..2048"
units: "megabyte"
default: "512"
"rpki-origin-as-validation-time": "integer", Prefix validation time (in seconds). Range \n: 5 - 60. Specify 0 to disable the timer
range: "0..60"
units: "second"
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"nsr": "boolean", TRUE to Enable non-stop routing\nsupportFALSE to Disable non-stop routing\nsupport
"disable-neighbor-logging": "null", Disable neighbor change logging
{
"interface-name": "string" Interface Name
} ] },
"read-only": "null", Allow duplicate table config and disable\nupdate generation
"graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR\ncapable peers
range: "1..4095"
units: "second"
default: "360"
"graceful-reset": "null", Reset gracefully if configuration change\nforces a peer reset
"update-out-logging": "null", Enables logging of update generation events
"graceful-restart-time": "integer", Restart time advertised to neighbors
range: "1..4095"
units: "second"
default: "120"
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"retain-routes": "boolean", Keep routes in RIB once BGP stops
"all-neighbors": "boolean" Also for neighbors without graceful\nmaintenance config
},
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"graceful-restart-purge-time": "integer", Time before stale routes are purged.
range: "1..6000"
units: "second"
default: "600"
{
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"default-metric": "integer", Default metric
range: "1..4294967295"
"update-error-handling-basic-ebgp-disable": "null", Inbound update basic error-handling for\nEBGP neighbors
"igp-loop-check": "null", Enable AS-path loop checking for iBGP peers
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"formatted-messages": "integer", Number of messages to be formatted per\nupdate group
range: "500..100000000"
default: "50000"
"desynchronize": "boolean", TRUE to enable desynchronization, FALSE\notherwise.
"enqueued-messages": "integer" Number of messages that can be enqueued in\ntotal
range: "500..100000000"
default: "250000"
},
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
}, {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null" Enter Graceful Maintenance mode to configure\nparametrs
},
"enforce-ibgp-out-policy": "null", Allow all attributes to be modified by\noutbound policy for iBGP peers
{
"username": "string", RPKI server username
"password": "string", The neighbor password. Leave unspecified when\ndisabling the password.
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"response-time": "integer", RPKI server response-time (15-3600\nseconds)
range: "15..3600"
units: "second"
"refresh-time": "integer", RPKI server refresh-time (15-3600\nseconds)
range: "15..3600"
units: "second"
"server": "string", Server address (opaque string)
"shutdown": "null", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"purge-time": "integer", RPKI server purge-time (30-360 seconds)
range: "30..360"
units: "second"
"port": "string", port
"transport": "string" RPKI server transport
} } ] },
"delay": "integer", Delay value (seconds)
range: "1..3600"
units: "second"
default: "120"
"always": "boolean" Set to TRUE to disable keepalive trigger\nbestpath and delay is enforced.
},
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"update-error-handling-basic-ibgp-disable": "null", Inbound update basic error-handling for\nIBGP neighbors
"next-hop-trigger-delay": "integer", Set the delay for triggering nexthop\nrecalculations
range: "0..300"
units: "second"
default: "5"
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
}, { {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"as-list-group-name": "string" Group name
} ] },
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"maximum-neighbors": "integer" Maximum number of neighbors that can be\nconfigured
range: "1..15000"
default: "10000"
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
{
"additional-paths-send": "string", Advertise additional paths Send capability
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] },
"global-table-mcast": "null", Enable global table multicast
"update-limit-sub-group-ebgp": "integer", Upper bound on update generation\ntransient memory usage for every EBGP\nSub-group
range: "1..512"
units: "megabyte"
default: "32"
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"router-id": "string" Router ID
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"inter-as-install": "null", Enable install remote MVPN routes to PIM\nin default VRF
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"disable-client-to-client-rr": "null", Disable client-to-client reflection
{ {
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
} ],
"cluster-type": "string", Type of cluster-id
{
"cluster-id-number": "integer" Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
} ] } ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"seconds": "integer", Delay, seconds part
range: "0..10"
units: "second"
"milliseconds": "integer" Delay, milliseconds part
range: "0..999"
units: "millisecond"
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"implicit-import": "null", Implicit import configuration
"label-security-rpf": "null", Calculate label-security RPF lists and\ninstall to RIB/LSD
"use-igpsr-label": "null", Use IGP SR label for resolution\nconfiguration
"wait-rib-install": "null", Wait for route install before sending\nupdates to neighbors
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"next-hop-non-critical-trigger-delay": "integer", Next hop Non-critical Trigger Delay
range: "0..4294967295"
units: "millisecond"
default: "10000"
"next-hop-critical-trigger-delay": "integer", Next hop Critical Trigger Delay
range: "0..4294967295"
units: "millisecond"
default: "3000"
"label-retain": "integer", Label retention time in minutes
range: "3..60"
units: "minute"
"seconds": "integer", Delay, seconds part
range: "0..10"
units: "second"
"milliseconds": "integer" Delay, milliseconds part
range: "0..999"
units: "millisecond"
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
}, {
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] },
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"scan-time": "integer", Configure background scanner interval for\nthis address family
range: "5..3600"
units: "second"
default: "60"
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", Instance Name. For Default instance use -\ndefault
"not-used": "integer" Not used
range: "0..127"
} ] },
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"table-policy": "string", Configure policy for installation of routes to\nRIB
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"source-rt-import-policy": "null" Enable sourcing of import route-targets \nfrom import-policy
},
"update-limit-sub-group-ibgp": "integer", Upper bound on update generation\ntransient memory usage for every IBGP\nSub-group
range: "1..512"
units: "megabyte"
default: "32"
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"update-limit-address-family": "integer", Upper bound on update generation\ntransient memory usage for the\naddress-family
range: "4..2048"
units: "megabyte"
default: "256"
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"segmented-mcast": "null", Enable segmented multicast
"attribute-download": "null", Attribute download configuration
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"additional-paths-receive": "string", Advertise additional paths Receive capability
"next-hop-route-policy": "string", Next hop policy to filter out nexthop\nnotification
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"disable-default-martian-check": "null", Disable default Martian Check
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"table-policy": "string", Configure policy for installation of routes to\nRIB
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] },
"prefix-sid-map": "null" Retrieve prefix sid mapping from SRMS
} ] },
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"neighbor-logging-detail": "null", Include extra detail in neighbor change\nmessages
"update-error-handling-extended-ebgp": "null", Inbound update extended error-handling for\nEBGP neighbors
"global-scan-time": "integer", Configure background scanner interval for\ngeneric scanner
range: "5..3600"
units: "second"
default: "60"
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"disable-enforce-first-as": "null", Disable enforce the first AS for EBGP routes
"graceful-restart": "null" Enable graceful restart support
}, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"prefix-length": "integer", Prefix length
range: "0..127"
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-group-name": "string", BGP neighbor group name
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"af-group-name": "string", BGP AF group name
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] } } ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"session-group-name": "string", BGP session group name
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } } } ],
"as": "string" Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
} ],
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/

Create operation of resource: instance

instancebody object

instance-name: string
in path

ID of instance-name

Request Content-Types: application/json
Request Example
{      {          {
            
"bgp-running": "null", Enable BGP. Deletion of this object causes\ndeletion of all the objects under FourByteAS\nassociated with this object.
{
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", Instance Name. For Default instance use -\ndefault
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
range: "0..127"
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] },
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"mvpn": "null", Connect to PIM/PIM6
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
{
"addrress": "string", Address
"as": "integer", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"minimum": "integer", Minimum Prefix Length
"maximum": "integer" Maximum Prefix Length
} ] },
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"update-error-handling-extended-ibgp": "null", Inbound update extended error-handling for\nIBGP neighbors
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"install-diversion": "null", Install diversion path to RIB/CEF
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"attribute-filter-group-name": "string", Group name
{
"attribute-start": "string", Start of attribute range
"attribute-end": "string", End of attribute range
"filter-action": "string" Filtering action
} ] } } ] },
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"update-limit-process": "integer", Upper bound on update generation transient\nmemory usage for the process
range: "16..2048"
units: "megabyte"
default: "512"
"rpki-origin-as-validation-time": "integer", Prefix validation time (in seconds). Range \n: 5 - 60. Specify 0 to disable the timer
range: "0..60"
units: "second"
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"nsr": "boolean", TRUE to Enable non-stop routing\nsupportFALSE to Disable non-stop routing\nsupport
"disable-neighbor-logging": "null", Disable neighbor change logging
{
"interface-name": "string" Interface Name
} ] },
"read-only": "null", Allow duplicate table config and disable\nupdate generation
"graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR\ncapable peers
range: "1..4095"
units: "second"
default: "360"
"graceful-reset": "null", Reset gracefully if configuration change\nforces a peer reset
"update-out-logging": "null", Enables logging of update generation events
"graceful-restart-time": "integer", Restart time advertised to neighbors
range: "1..4095"
units: "second"
default: "120"
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"retain-routes": "boolean", Keep routes in RIB once BGP stops
"all-neighbors": "boolean" Also for neighbors without graceful\nmaintenance config
},
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"graceful-restart-purge-time": "integer", Time before stale routes are purged.
range: "1..6000"
units: "second"
default: "600"
{
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"default-metric": "integer", Default metric
range: "1..4294967295"
"update-error-handling-basic-ebgp-disable": "null", Inbound update basic error-handling for\nEBGP neighbors
"igp-loop-check": "null", Enable AS-path loop checking for iBGP peers
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"formatted-messages": "integer", Number of messages to be formatted per\nupdate group
range: "500..100000000"
default: "50000"
"desynchronize": "boolean", TRUE to enable desynchronization, FALSE\notherwise.
"enqueued-messages": "integer" Number of messages that can be enqueued in\ntotal
range: "500..100000000"
default: "250000"
},
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
}, {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null" Enter Graceful Maintenance mode to configure\nparametrs
},
"enforce-ibgp-out-policy": "null", Allow all attributes to be modified by\noutbound policy for iBGP peers
{
"username": "string", RPKI server username
"password": "string", The neighbor password. Leave unspecified when\ndisabling the password.
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"response-time": "integer", RPKI server response-time (15-3600\nseconds)
range: "15..3600"
units: "second"
"refresh-time": "integer", RPKI server refresh-time (15-3600\nseconds)
range: "15..3600"
units: "second"
"server": "string", Server address (opaque string)
"shutdown": "null", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"purge-time": "integer", RPKI server purge-time (30-360 seconds)
range: "30..360"
units: "second"
"port": "string", port
"transport": "string" RPKI server transport
} } ] },
"delay": "integer", Delay value (seconds)
range: "1..3600"
units: "second"
default: "120"
"always": "boolean" Set to TRUE to disable keepalive trigger\nbestpath and delay is enforced.
},
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"update-error-handling-basic-ibgp-disable": "null", Inbound update basic error-handling for\nIBGP neighbors
"next-hop-trigger-delay": "integer", Set the delay for triggering nexthop\nrecalculations
range: "0..300"
units: "second"
default: "5"
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
}, { {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"as-list-group-name": "string" Group name
} ] },
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"maximum-neighbors": "integer" Maximum number of neighbors that can be\nconfigured
range: "1..15000"
default: "10000"
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
{
"additional-paths-send": "string", Advertise additional paths Send capability
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] },
"global-table-mcast": "null", Enable global table multicast
"update-limit-sub-group-ebgp": "integer", Upper bound on update generation\ntransient memory usage for every EBGP\nSub-group
range: "1..512"
units: "megabyte"
default: "32"
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"router-id": "string" Router ID
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"inter-as-install": "null", Enable install remote MVPN routes to PIM\nin default VRF
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"disable-client-to-client-rr": "null", Disable client-to-client reflection
{ {
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
} ],
"cluster-type": "string", Type of cluster-id
{
"cluster-id-number": "integer" Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
} ] } ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"seconds": "integer", Delay, seconds part
range: "0..10"
units: "second"
"milliseconds": "integer" Delay, milliseconds part
range: "0..999"
units: "millisecond"
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"implicit-import": "null", Implicit import configuration
"label-security-rpf": "null", Calculate label-security RPF lists and\ninstall to RIB/LSD
"use-igpsr-label": "null", Use IGP SR label for resolution\nconfiguration
"wait-rib-install": "null", Wait for route install before sending\nupdates to neighbors
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"next-hop-non-critical-trigger-delay": "integer", Next hop Non-critical Trigger Delay
range: "0..4294967295"
units: "millisecond"
default: "10000"
"next-hop-critical-trigger-delay": "integer", Next hop Critical Trigger Delay
range: "0..4294967295"
units: "millisecond"
default: "3000"
"label-retain": "integer", Label retention time in minutes
range: "3..60"
units: "minute"
"seconds": "integer", Delay, seconds part
range: "0..10"
units: "second"
"milliseconds": "integer" Delay, milliseconds part
range: "0..999"
units: "millisecond"
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
}, {
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] },
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"scan-time": "integer", Configure background scanner interval for\nthis address family
range: "5..3600"
units: "second"
default: "60"
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", Instance Name. For Default instance use -\ndefault
"not-used": "integer" Not used
range: "0..127"
} ] },
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"table-policy": "string", Configure policy for installation of routes to\nRIB
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"source-rt-import-policy": "null" Enable sourcing of import route-targets \nfrom import-policy
},
"update-limit-sub-group-ibgp": "integer", Upper bound on update generation\ntransient memory usage for every IBGP\nSub-group
range: "1..512"
units: "megabyte"
default: "32"
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"update-limit-address-family": "integer", Upper bound on update generation\ntransient memory usage for the\naddress-family
range: "4..2048"
units: "megabyte"
default: "256"
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"segmented-mcast": "null", Enable segmented multicast
"attribute-download": "null", Attribute download configuration
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"additional-paths-receive": "string", Advertise additional paths Receive capability
"next-hop-route-policy": "string", Next hop policy to filter out nexthop\nnotification
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"disable-default-martian-check": "null", Disable default Martian Check
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"table-policy": "string", Configure policy for installation of routes to\nRIB
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] },
"prefix-sid-map": "null" Retrieve prefix sid mapping from SRMS
} ] },
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"neighbor-logging-detail": "null", Include extra detail in neighbor change\nmessages
"update-error-handling-extended-ebgp": "null", Inbound update extended error-handling for\nEBGP neighbors
"global-scan-time": "integer", Configure background scanner interval for\ngeneric scanner
range: "5..3600"
units: "second"
default: "60"
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"disable-enforce-first-as": "null", Disable enforce the first AS for EBGP routes
"graceful-restart": "null" Enable graceful restart support
}, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"prefix-length": "integer", Prefix length
range: "0..127"
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-group-name": "string", BGP neighbor group name
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"af-group-name": "string", BGP AF group name
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] } } ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"session-group-name": "string", BGP session group name
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } } } ],
"as": "string" Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
} ],
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/

Delete operation of resource: instance

instance-name: string
in path

ID of instance-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/

Retrieve operation of resource: instance

instance-name: string
in path

ID of instance-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {          {
            
"bgp-running": "null", Enable BGP. Deletion of this object causes\ndeletion of all the objects under FourByteAS\nassociated with this object.
{
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", Instance Name. For Default instance use -\ndefault
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
range: "0..127"
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] },
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"mvpn": "null", Connect to PIM/PIM6
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
{
"addrress": "string", Address
"as": "integer", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"minimum": "integer", Minimum Prefix Length
"maximum": "integer" Maximum Prefix Length
} ] },
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"update-error-handling-extended-ibgp": "null", Inbound update extended error-handling for\nIBGP neighbors
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"install-diversion": "null", Install diversion path to RIB/CEF
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"attribute-filter-group-name": "string", Group name
{
"attribute-start": "string", Start of attribute range
"attribute-end": "string", End of attribute range
"filter-action": "string" Filtering action
} ] } } ] },
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"update-limit-process": "integer", Upper bound on update generation transient\nmemory usage for the process
range: "16..2048"
units: "megabyte"
default: "512"
"rpki-origin-as-validation-time": "integer", Prefix validation time (in seconds). Range \n: 5 - 60. Specify 0 to disable the timer
range: "0..60"
units: "second"
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"nsr": "boolean", TRUE to Enable non-stop routing\nsupportFALSE to Disable non-stop routing\nsupport
"disable-neighbor-logging": "null", Disable neighbor change logging
{
"interface-name": "string" Interface Name
} ] },
"read-only": "null", Allow duplicate table config and disable\nupdate generation
"graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR\ncapable peers
range: "1..4095"
units: "second"
default: "360"
"graceful-reset": "null", Reset gracefully if configuration change\nforces a peer reset
"update-out-logging": "null", Enables logging of update generation events
"graceful-restart-time": "integer", Restart time advertised to neighbors
range: "1..4095"
units: "second"
default: "120"
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"retain-routes": "boolean", Keep routes in RIB once BGP stops
"all-neighbors": "boolean" Also for neighbors without graceful\nmaintenance config
},
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"graceful-restart-purge-time": "integer", Time before stale routes are purged.
range: "1..6000"
units: "second"
default: "600"
{
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"default-metric": "integer", Default metric
range: "1..4294967295"
"update-error-handling-basic-ebgp-disable": "null", Inbound update basic error-handling for\nEBGP neighbors
"igp-loop-check": "null", Enable AS-path loop checking for iBGP peers
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"formatted-messages": "integer", Number of messages to be formatted per\nupdate group
range: "500..100000000"
default: "50000"
"desynchronize": "boolean", TRUE to enable desynchronization, FALSE\notherwise.
"enqueued-messages": "integer" Number of messages that can be enqueued in\ntotal
range: "500..100000000"
default: "250000"
},
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
}, {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null" Enter Graceful Maintenance mode to configure\nparametrs
},
"enforce-ibgp-out-policy": "null", Allow all attributes to be modified by\noutbound policy for iBGP peers
{
"username": "string", RPKI server username
"password": "string", The neighbor password. Leave unspecified when\ndisabling the password.
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"response-time": "integer", RPKI server response-time (15-3600\nseconds)
range: "15..3600"
units: "second"
"refresh-time": "integer", RPKI server refresh-time (15-3600\nseconds)
range: "15..3600"
units: "second"
"server": "string", Server address (opaque string)
"shutdown": "null", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"purge-time": "integer", RPKI server purge-time (30-360 seconds)
range: "30..360"
units: "second"
"port": "string", port
"transport": "string" RPKI server transport
} } ] },
"delay": "integer", Delay value (seconds)
range: "1..3600"
units: "second"
default: "120"
"always": "boolean" Set to TRUE to disable keepalive trigger\nbestpath and delay is enforced.
},
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"update-error-handling-basic-ibgp-disable": "null", Inbound update basic error-handling for\nIBGP neighbors
"next-hop-trigger-delay": "integer", Set the delay for triggering nexthop\nrecalculations
range: "0..300"
units: "second"
default: "5"
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
}, { {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"as-list-group-name": "string" Group name
} ] },
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"maximum-neighbors": "integer" Maximum number of neighbors that can be\nconfigured
range: "1..15000"
default: "10000"
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
{
"additional-paths-send": "string", Advertise additional paths Send capability
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] },
"global-table-mcast": "null", Enable global table multicast
"update-limit-sub-group-ebgp": "integer", Upper bound on update generation\ntransient memory usage for every EBGP\nSub-group
range: "1..512"
units: "megabyte"
default: "32"
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"router-id": "string" Router ID
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"inter-as-install": "null", Enable install remote MVPN routes to PIM\nin default VRF
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"disable-client-to-client-rr": "null", Disable client-to-client reflection
{ {
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
} ],
"cluster-type": "string", Type of cluster-id
{
"cluster-id-number": "integer" Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
} ] } ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"seconds": "integer", Delay, seconds part
range: "0..10"
units: "second"
"milliseconds": "integer" Delay, milliseconds part
range: "0..999"
units: "millisecond"
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"implicit-import": "null", Implicit import configuration
"label-security-rpf": "null", Calculate label-security RPF lists and\ninstall to RIB/LSD
"use-igpsr-label": "null", Use IGP SR label for resolution\nconfiguration
"wait-rib-install": "null", Wait for route install before sending\nupdates to neighbors
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"next-hop-non-critical-trigger-delay": "integer", Next hop Non-critical Trigger Delay
range: "0..4294967295"
units: "millisecond"
default: "10000"
"next-hop-critical-trigger-delay": "integer", Next hop Critical Trigger Delay
range: "0..4294967295"
units: "millisecond"
default: "3000"
"label-retain": "integer", Label retention time in minutes
range: "3..60"
units: "minute"
"seconds": "integer", Delay, seconds part
range: "0..10"
units: "second"
"milliseconds": "integer" Delay, milliseconds part
range: "0..999"
units: "millisecond"
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
}, {
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] },
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"scan-time": "integer", Configure background scanner interval for\nthis address family
range: "5..3600"
units: "second"
default: "60"
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", Instance Name. For Default instance use -\ndefault
"not-used": "integer" Not used
range: "0..127"
} ] },
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"table-policy": "string", Configure policy for installation of routes to\nRIB
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"source-rt-import-policy": "null" Enable sourcing of import route-targets \nfrom import-policy
},
"update-limit-sub-group-ibgp": "integer", Upper bound on update generation\ntransient memory usage for every IBGP\nSub-group
range: "1..512"
units: "megabyte"
default: "32"
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"update-limit-address-family": "integer", Upper bound on update generation\ntransient memory usage for the\naddress-family
range: "4..2048"
units: "megabyte"
default: "256"
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"segmented-mcast": "null", Enable segmented multicast
"attribute-download": "null", Attribute download configuration
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"additional-paths-receive": "string", Advertise additional paths Receive capability
"next-hop-route-policy": "string", Next hop policy to filter out nexthop\nnotification
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"disable-default-martian-check": "null", Disable default Martian Check
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"table-policy": "string", Configure policy for installation of routes to\nRIB
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} ] },
"prefix-sid-map": "null" Retrieve prefix sid mapping from SRMS
} ] },
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"neighbor-logging-detail": "null", Include extra detail in neighbor change\nmessages
"update-error-handling-extended-ebgp": "null", Inbound update extended error-handling for\nEBGP neighbors
"global-scan-time": "integer", Configure background scanner interval for\ngeneric scanner
range: "5..3600"
units: "second"
default: "60"
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"disable-enforce-first-as": "null", Disable enforce the first AS for EBGP routes
"graceful-restart": "null" Enable graceful restart support
}, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"prefix-length": "integer", Prefix length
range: "0..127"
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-group-name": "string", BGP neighbor group name
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"af-group-name": "string", BGP AF group name
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] } } ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"session-group-name": "string", BGP session group name
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } } } ],
"as": "string" Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
} ],
"instance-name": "string" Instance Name. For Default instance use -\ndefault
} }

INSTANCE-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/

Update operation of resource: instance-as

instance-asbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

Request Content-Types: application/json
Request Example
{      {
        
"bgp-running": "null", Enable BGP. Deletion of this object causes\ndeletion of all the objects under FourByteAS\nassociated with this object.
{
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
range: "0..127"
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] },
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"mvpn": "null", Connect to PIM/PIM6
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
{
"addrress": "string", Address
"as": "integer", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"minimum": "integer", Minimum Prefix Length
"maximum": "integer" Maximum Prefix Length
} ] },
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"update-error-handling-extended-ibgp": "null", Inbound update extended error-handling for\nIBGP neighbors
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"install-diversion": "null", Install diversion path to RIB/CEF
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"attribute-filter-group-name": "string", Group name
{
"attribute-start": "string", Start of attribute range
"attribute-end": "string", End of attribute range
"filter-action": "string" Filtering action
} ] } } ] },
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"update-limit-process": "integer", Upper bound on update generation transient\nmemory usage for the process
range: "16..2048"
units: "megabyte"
default: "512"
"rpki-origin-as-validation-time": "integer", Prefix validation time (in seconds). Range \n: 5 - 60. Specify 0 to disable the timer
range: "0..60"
units: "second"
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"nsr": "boolean", TRUE to Enable non-stop routing\nsupportFALSE to Disable non-stop routing\nsupport
"disable-neighbor-logging": "null", Disable neighbor change logging
{
"interface-name": "string" Interface Name
} ] },
"read-only": "null", Allow duplicate table config and disable\nupdate generation
"graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR\ncapable peers
range: "1..4095"
units: "second"
default: "360"
"graceful-reset": "null", Reset gracefully if configuration change\nforces a peer reset
"update-out-logging": "null", Enables logging of update generation events
"graceful-restart-time": "integer", Restart time advertised to neighbors
range: "1..4095"
units: "second"
default: "120"
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"retain-routes": "boolean", Keep routes in RIB once BGP stops
"all-neighbors": "boolean" Also for neighbors without graceful\nmaintenance config
},
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"graceful-restart-purge-time": "integer", Time before stale routes are purged.
range: "1..6000"
units: "second"
default: "600"
{
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"default-metric": "integer", Default metric
range: "1..4294967295"
"update-error-handling-basic-ebgp-disable": "null", Inbound update basic error-handling for\nEBGP neighbors
"igp-loop-check": "null", Enable AS-path loop checking for iBGP peers
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"formatted-messages": "integer", Number of messages to be formatted per\nupdate group
range: "500..100000000"
default: "50000"
"desynchronize": "boolean", TRUE to enable desynchronization, FALSE\notherwise.
"enqueued-messages": "integer" Number of messages that can be enqueued in\ntotal
range: "500..100000000"
default: "250000"
},
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
}, {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null" Enter Graceful Maintenance mode to configure\nparametrs
},
"enforce-ibgp-out-policy": "null", Allow all attributes to be modified by\noutbound policy for iBGP peers
{
"username": "string", RPKI server username
"password": "string", The neighbor password. Leave unspecified when\ndisabling the password.
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"response-time": "integer", RPKI server response-time (15-3600\nseconds)
range: "15..3600"
units: "second"
"refresh-time": "integer", RPKI server refresh-time (15-3600\nseconds)
range: "15..3600"
units: "second"
"server": "string", Server address (opaque string)
"shutdown": "null", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"purge-time": "integer", RPKI server purge-time (30-360 seconds)
range: "30..360"
units: "second"
"port": "string", port
"transport": "string" RPKI server transport
} } ] },
"delay": "integer", Delay value (seconds)
range: "1..3600"
units: "second"
default: "120"
"always": "boolean" Set to TRUE to disable keepalive trigger\nbestpath and delay is enforced.
},
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"update-error-handling-basic-ibgp-disable": "null", Inbound update basic error-handling for\nIBGP neighbors
"next-hop-trigger-delay": "integer", Set the delay for triggering nexthop\nrecalculations
range: "0..300"
units: "second"
default: "5"
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
}, { {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"as-list-group-name": "string" Group name
} ] },
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"maximum-neighbors": "integer" Maximum number of neighbors that can be\nconfigured
range: "1..15000"
default: "10000"
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
{
"additional-paths-send": "string", Advertise additional paths Send capability
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"global-table-mcast": "null", Enable global table multicast
"update-limit-sub-group-ebgp": "integer", Upper bound on update generation\ntransient memory usage for every EBGP\nSub-group
range: "1..512"
units: "megabyte"
default: "32"
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"router-id": "string" Router ID
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"inter-as-install": "null", Enable install remote MVPN routes to PIM\nin default VRF
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"disable-client-to-client-rr": "null", Disable client-to-client reflection
{ {
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
} ],
"cluster-type": "string", Type of cluster-id
{
"cluster-id-number": "integer" Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
} ] } ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"seconds": "integer", Delay, seconds part
range: "0..10"
units: "second"
"milliseconds": "integer" Delay, milliseconds part
range: "0..999"
units: "millisecond"
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"implicit-import": "null", Implicit import configuration
"label-security-rpf": "null", Calculate label-security RPF lists and\ninstall to RIB/LSD
"use-igpsr-label": "null", Use IGP SR label for resolution\nconfiguration
"wait-rib-install": "null", Wait for route install before sending\nupdates to neighbors
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"next-hop-non-critical-trigger-delay": "integer", Next hop Non-critical Trigger Delay
range: "0..4294967295"
units: "millisecond"
default: "10000"
"next-hop-critical-trigger-delay": "integer", Next hop Critical Trigger Delay
range: "0..4294967295"
units: "millisecond"
default: "3000"
"label-retain": "integer", Label retention time in minutes
range: "3..60"
units: "minute"
"seconds": "integer", Delay, seconds part
range: "0..10"
units: "second"
"milliseconds": "integer" Delay, milliseconds part
range: "0..999"
units: "millisecond"
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
}, {
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"scan-time": "integer", Configure background scanner interval for\nthis address family
range: "5..3600"
units: "second"
default: "60"
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"table-policy": "string", Configure policy for installation of routes to\nRIB
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"source-rt-import-policy": "null" Enable sourcing of import route-targets \nfrom import-policy
},
"update-limit-sub-group-ibgp": "integer", Upper bound on update generation\ntransient memory usage for every IBGP\nSub-group
range: "1..512"
units: "megabyte"
default: "32"
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"update-limit-address-family": "integer", Upper bound on update generation\ntransient memory usage for the\naddress-family
range: "4..2048"
units: "megabyte"
default: "256"
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"segmented-mcast": "null", Enable segmented multicast
"attribute-download": "null", Attribute download configuration
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"additional-paths-receive": "string", Advertise additional paths Receive capability
"next-hop-route-policy": "string", Next hop policy to filter out nexthop\nnotification
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"disable-default-martian-check": "null", Disable default Martian Check
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"table-policy": "string", Configure policy for installation of routes to\nRIB
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"prefix-sid-map": "null" Retrieve prefix sid mapping from SRMS
} ] },
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"neighbor-logging-detail": "null", Include extra detail in neighbor change\nmessages
"update-error-handling-extended-ebgp": "null", Inbound update extended error-handling for\nEBGP neighbors
"global-scan-time": "integer", Configure background scanner interval for\ngeneric scanner
range: "5..3600"
units: "second"
default: "60"
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"disable-enforce-first-as": "null", Disable enforce the first AS for EBGP routes
"graceful-restart": "null" Enable graceful restart support
}, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"prefix-length": "integer", Prefix length
range: "0..127"
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-group-name": "string", BGP neighbor group name
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"af-group-name": "string", BGP AF group name
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] } } ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"session-group-name": "string", BGP session group name
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } } } ],
"as": "string" Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/

Create operation of resource: instance-as

instance-asbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

Request Content-Types: application/json
Request Example
{      {
        
"bgp-running": "null", Enable BGP. Deletion of this object causes\ndeletion of all the objects under FourByteAS\nassociated with this object.
{
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
range: "0..127"
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] },
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"mvpn": "null", Connect to PIM/PIM6
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
{
"addrress": "string", Address
"as": "integer", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"minimum": "integer", Minimum Prefix Length
"maximum": "integer" Maximum Prefix Length
} ] },
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"update-error-handling-extended-ibgp": "null", Inbound update extended error-handling for\nIBGP neighbors
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"install-diversion": "null", Install diversion path to RIB/CEF
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"attribute-filter-group-name": "string", Group name
{
"attribute-start": "string", Start of attribute range
"attribute-end": "string", End of attribute range
"filter-action": "string" Filtering action
} ] } } ] },
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"update-limit-process": "integer", Upper bound on update generation transient\nmemory usage for the process
range: "16..2048"
units: "megabyte"
default: "512"
"rpki-origin-as-validation-time": "integer", Prefix validation time (in seconds). Range \n: 5 - 60. Specify 0 to disable the timer
range: "0..60"
units: "second"
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"nsr": "boolean", TRUE to Enable non-stop routing\nsupportFALSE to Disable non-stop routing\nsupport
"disable-neighbor-logging": "null", Disable neighbor change logging
{
"interface-name": "string" Interface Name
} ] },
"read-only": "null", Allow duplicate table config and disable\nupdate generation
"graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR\ncapable peers
range: "1..4095"
units: "second"
default: "360"
"graceful-reset": "null", Reset gracefully if configuration change\nforces a peer reset
"update-out-logging": "null", Enables logging of update generation events
"graceful-restart-time": "integer", Restart time advertised to neighbors
range: "1..4095"
units: "second"
default: "120"
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"retain-routes": "boolean", Keep routes in RIB once BGP stops
"all-neighbors": "boolean" Also for neighbors without graceful\nmaintenance config
},
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"graceful-restart-purge-time": "integer", Time before stale routes are purged.
range: "1..6000"
units: "second"
default: "600"
{
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"default-metric": "integer", Default metric
range: "1..4294967295"
"update-error-handling-basic-ebgp-disable": "null", Inbound update basic error-handling for\nEBGP neighbors
"igp-loop-check": "null", Enable AS-path loop checking for iBGP peers
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"formatted-messages": "integer", Number of messages to be formatted per\nupdate group
range: "500..100000000"
default: "50000"
"desynchronize": "boolean", TRUE to enable desynchronization, FALSE\notherwise.
"enqueued-messages": "integer" Number of messages that can be enqueued in\ntotal
range: "500..100000000"
default: "250000"
},
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
}, {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null" Enter Graceful Maintenance mode to configure\nparametrs
},
"enforce-ibgp-out-policy": "null", Allow all attributes to be modified by\noutbound policy for iBGP peers
{
"username": "string", RPKI server username
"password": "string", The neighbor password. Leave unspecified when\ndisabling the password.
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"response-time": "integer", RPKI server response-time (15-3600\nseconds)
range: "15..3600"
units: "second"
"refresh-time": "integer", RPKI server refresh-time (15-3600\nseconds)
range: "15..3600"
units: "second"
"server": "string", Server address (opaque string)
"shutdown": "null", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"purge-time": "integer", RPKI server purge-time (30-360 seconds)
range: "30..360"
units: "second"
"port": "string", port
"transport": "string" RPKI server transport
} } ] },
"delay": "integer", Delay value (seconds)
range: "1..3600"
units: "second"
default: "120"
"always": "boolean" Set to TRUE to disable keepalive trigger\nbestpath and delay is enforced.
},
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"update-error-handling-basic-ibgp-disable": "null", Inbound update basic error-handling for\nIBGP neighbors
"next-hop-trigger-delay": "integer", Set the delay for triggering nexthop\nrecalculations
range: "0..300"
units: "second"
default: "5"
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
}, { {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"as-list-group-name": "string" Group name
} ] },
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"maximum-neighbors": "integer" Maximum number of neighbors that can be\nconfigured
range: "1..15000"
default: "10000"
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
{
"additional-paths-send": "string", Advertise additional paths Send capability
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"global-table-mcast": "null", Enable global table multicast
"update-limit-sub-group-ebgp": "integer", Upper bound on update generation\ntransient memory usage for every EBGP\nSub-group
range: "1..512"
units: "megabyte"
default: "32"
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"router-id": "string" Router ID
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"inter-as-install": "null", Enable install remote MVPN routes to PIM\nin default VRF
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"disable-client-to-client-rr": "null", Disable client-to-client reflection
{ {
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
} ],
"cluster-type": "string", Type of cluster-id
{
"cluster-id-number": "integer" Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
} ] } ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"seconds": "integer", Delay, seconds part
range: "0..10"
units: "second"
"milliseconds": "integer" Delay, milliseconds part
range: "0..999"
units: "millisecond"
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"implicit-import": "null", Implicit import configuration
"label-security-rpf": "null", Calculate label-security RPF lists and\ninstall to RIB/LSD
"use-igpsr-label": "null", Use IGP SR label for resolution\nconfiguration
"wait-rib-install": "null", Wait for route install before sending\nupdates to neighbors
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"next-hop-non-critical-trigger-delay": "integer", Next hop Non-critical Trigger Delay
range: "0..4294967295"
units: "millisecond"
default: "10000"
"next-hop-critical-trigger-delay": "integer", Next hop Critical Trigger Delay
range: "0..4294967295"
units: "millisecond"
default: "3000"
"label-retain": "integer", Label retention time in minutes
range: "3..60"
units: "minute"
"seconds": "integer", Delay, seconds part
range: "0..10"
units: "second"
"milliseconds": "integer" Delay, milliseconds part
range: "0..999"
units: "millisecond"
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
}, {
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"scan-time": "integer", Configure background scanner interval for\nthis address family
range: "5..3600"
units: "second"
default: "60"
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"table-policy": "string", Configure policy for installation of routes to\nRIB
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"source-rt-import-policy": "null" Enable sourcing of import route-targets \nfrom import-policy
},
"update-limit-sub-group-ibgp": "integer", Upper bound on update generation\ntransient memory usage for every IBGP\nSub-group
range: "1..512"
units: "megabyte"
default: "32"
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"update-limit-address-family": "integer", Upper bound on update generation\ntransient memory usage for the\naddress-family
range: "4..2048"
units: "megabyte"
default: "256"
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"segmented-mcast": "null", Enable segmented multicast
"attribute-download": "null", Attribute download configuration
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"additional-paths-receive": "string", Advertise additional paths Receive capability
"next-hop-route-policy": "string", Next hop policy to filter out nexthop\nnotification
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"disable-default-martian-check": "null", Disable default Martian Check
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"table-policy": "string", Configure policy for installation of routes to\nRIB
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"prefix-sid-map": "null" Retrieve prefix sid mapping from SRMS
} ] },
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"neighbor-logging-detail": "null", Include extra detail in neighbor change\nmessages
"update-error-handling-extended-ebgp": "null", Inbound update extended error-handling for\nEBGP neighbors
"global-scan-time": "integer", Configure background scanner interval for\ngeneric scanner
range: "5..3600"
units: "second"
default: "60"
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"disable-enforce-first-as": "null", Disable enforce the first AS for EBGP routes
"graceful-restart": "null" Enable graceful restart support
}, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"prefix-length": "integer", Prefix length
range: "0..127"
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-group-name": "string", BGP neighbor group name
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"af-group-name": "string", BGP AF group name
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] } } ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"session-group-name": "string", BGP session group name
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } } } ],
"as": "string" Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/

Delete operation of resource: instance-as

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/

Retrieve operation of resource: instance-as

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"bgp-running": "null", Enable BGP. Deletion of this object causes\ndeletion of all the objects under FourByteAS\nassociated with this object.
{
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
range: "0..127"
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] },
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"mvpn": "null", Connect to PIM/PIM6
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
{
"addrress": "string", Address
"as": "integer", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"minimum": "integer", Minimum Prefix Length
"maximum": "integer" Maximum Prefix Length
} ] },
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"update-error-handling-extended-ibgp": "null", Inbound update extended error-handling for\nIBGP neighbors
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"install-diversion": "null", Install diversion path to RIB/CEF
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"attribute-filter-group-name": "string", Group name
{
"attribute-start": "string", Start of attribute range
"attribute-end": "string", End of attribute range
"filter-action": "string" Filtering action
} ] } } ] },
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"update-limit-process": "integer", Upper bound on update generation transient\nmemory usage for the process
range: "16..2048"
units: "megabyte"
default: "512"
"rpki-origin-as-validation-time": "integer", Prefix validation time (in seconds). Range \n: 5 - 60. Specify 0 to disable the timer
range: "0..60"
units: "second"
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"nsr": "boolean", TRUE to Enable non-stop routing\nsupportFALSE to Disable non-stop routing\nsupport
"disable-neighbor-logging": "null", Disable neighbor change logging
{
"interface-name": "string" Interface Name
} ] },
"read-only": "null", Allow duplicate table config and disable\nupdate generation
"graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR\ncapable peers
range: "1..4095"
units: "second"
default: "360"
"graceful-reset": "null", Reset gracefully if configuration change\nforces a peer reset
"update-out-logging": "null", Enables logging of update generation events
"graceful-restart-time": "integer", Restart time advertised to neighbors
range: "1..4095"
units: "second"
default: "120"
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"retain-routes": "boolean", Keep routes in RIB once BGP stops
"all-neighbors": "boolean" Also for neighbors without graceful\nmaintenance config
},
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"graceful-restart-purge-time": "integer", Time before stale routes are purged.
range: "1..6000"
units: "second"
default: "600"
{
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"default-metric": "integer", Default metric
range: "1..4294967295"
"update-error-handling-basic-ebgp-disable": "null", Inbound update basic error-handling for\nEBGP neighbors
"igp-loop-check": "null", Enable AS-path loop checking for iBGP peers
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"formatted-messages": "integer", Number of messages to be formatted per\nupdate group
range: "500..100000000"
default: "50000"
"desynchronize": "boolean", TRUE to enable desynchronization, FALSE\notherwise.
"enqueued-messages": "integer" Number of messages that can be enqueued in\ntotal
range: "500..100000000"
default: "250000"
},
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
}, {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null" Enter Graceful Maintenance mode to configure\nparametrs
},
"enforce-ibgp-out-policy": "null", Allow all attributes to be modified by\noutbound policy for iBGP peers
{
"username": "string", RPKI server username
"password": "string", The neighbor password. Leave unspecified when\ndisabling the password.
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"response-time": "integer", RPKI server response-time (15-3600\nseconds)
range: "15..3600"
units: "second"
"refresh-time": "integer", RPKI server refresh-time (15-3600\nseconds)
range: "15..3600"
units: "second"
"server": "string", Server address (opaque string)
"shutdown": "null", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"purge-time": "integer", RPKI server purge-time (30-360 seconds)
range: "30..360"
units: "second"
"port": "string", port
"transport": "string" RPKI server transport
} } ] },
"delay": "integer", Delay value (seconds)
range: "1..3600"
units: "second"
default: "120"
"always": "boolean" Set to TRUE to disable keepalive trigger\nbestpath and delay is enforced.
},
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"update-error-handling-basic-ibgp-disable": "null", Inbound update basic error-handling for\nIBGP neighbors
"next-hop-trigger-delay": "integer", Set the delay for triggering nexthop\nrecalculations
range: "0..300"
units: "second"
default: "5"
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
}, { {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"as-list-group-name": "string" Group name
} ] },
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"maximum-neighbors": "integer" Maximum number of neighbors that can be\nconfigured
range: "1..15000"
default: "10000"
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
{
"additional-paths-send": "string", Advertise additional paths Send capability
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"global-table-mcast": "null", Enable global table multicast
"update-limit-sub-group-ebgp": "integer", Upper bound on update generation\ntransient memory usage for every EBGP\nSub-group
range: "1..512"
units: "megabyte"
default: "32"
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"router-id": "string" Router ID
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"inter-as-install": "null", Enable install remote MVPN routes to PIM\nin default VRF
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"disable-client-to-client-rr": "null", Disable client-to-client reflection
{ {
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
} ],
"cluster-type": "string", Type of cluster-id
{
"cluster-id-number": "integer" Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
} ] } ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"seconds": "integer", Delay, seconds part
range: "0..10"
units: "second"
"milliseconds": "integer" Delay, milliseconds part
range: "0..999"
units: "millisecond"
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"implicit-import": "null", Implicit import configuration
"label-security-rpf": "null", Calculate label-security RPF lists and\ninstall to RIB/LSD
"use-igpsr-label": "null", Use IGP SR label for resolution\nconfiguration
"wait-rib-install": "null", Wait for route install before sending\nupdates to neighbors
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"next-hop-non-critical-trigger-delay": "integer", Next hop Non-critical Trigger Delay
range: "0..4294967295"
units: "millisecond"
default: "10000"
"next-hop-critical-trigger-delay": "integer", Next hop Critical Trigger Delay
range: "0..4294967295"
units: "millisecond"
default: "3000"
"label-retain": "integer", Label retention time in minutes
range: "3..60"
units: "minute"
"seconds": "integer", Delay, seconds part
range: "0..10"
units: "second"
"milliseconds": "integer" Delay, milliseconds part
range: "0..999"
units: "millisecond"
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
}, {
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"scan-time": "integer", Configure background scanner interval for\nthis address family
range: "5..3600"
units: "second"
default: "60"
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"table-policy": "string", Configure policy for installation of routes to\nRIB
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"source-rt-import-policy": "null" Enable sourcing of import route-targets \nfrom import-policy
},
"update-limit-sub-group-ibgp": "integer", Upper bound on update generation\ntransient memory usage for every IBGP\nSub-group
range: "1..512"
units: "megabyte"
default: "32"
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"update-limit-address-family": "integer", Upper bound on update generation\ntransient memory usage for the\naddress-family
range: "4..2048"
units: "megabyte"
default: "256"
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"segmented-mcast": "null", Enable segmented multicast
"attribute-download": "null", Attribute download configuration
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"additional-paths-receive": "string", Advertise additional paths Receive capability
"next-hop-route-policy": "string", Next hop policy to filter out nexthop\nnotification
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"disable-default-martian-check": "null", Disable default Martian Check
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"table-policy": "string", Configure policy for installation of routes to\nRIB
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"prefix-sid-map": "null" Retrieve prefix sid mapping from SRMS
} ] },
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"neighbor-logging-detail": "null", Include extra detail in neighbor change\nmessages
"update-error-handling-extended-ebgp": "null", Inbound update extended error-handling for\nEBGP neighbors
"global-scan-time": "integer", Configure background scanner interval for\ngeneric scanner
range: "5..3600"
units: "second"
default: "60"
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"disable-enforce-first-as": "null", Disable enforce the first AS for EBGP routes
"graceful-restart": "null" Enable graceful restart support
}, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"prefix-length": "integer", Prefix length
range: "0..127"
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-group-name": "string", BGP neighbor group name
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"af-group-name": "string", BGP AF group name
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] } } ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"session-group-name": "string", BGP session group name
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } } } ],
"as": "string" Higher 16 bits of 4-byte Autonomous system\nnumber
range: "1..4294967295"
} }

FOUR-BYTE-AS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/

Update operation of resource: four-byte-as

four-byte-asbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

Request Content-Types: application/json
Request Example
{    
"bgp-running": "null", Enable BGP. Deletion of this object causes\ndeletion of all the objects under FourByteAS\nassociated with this object.
"as": "string", AS number
{
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
"half-life": "integer", Half-life time for the penalty (minutes).
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
"suppress-threshold": "integer", Value to start suppressing a route.
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
"local-routes": "integer", Distance for local routes
"internal-routes": "integer" Distance for routes internal to the AS
},
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
"keepalive": "integer" Keepalive interval (seconds)
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
"interval": "integer" Hello interval for BFD sessions created by BGP
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] },
"mvpn": "null", Connect to PIM/PIM6
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
{
"addrress": "string", Address
"as": "integer", AS number
"minimum": "integer", Minimum Prefix Length
"maximum": "integer" Maximum Prefix Length
} ] },
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"update-error-handling-extended-ibgp": "null", Inbound update extended error-handling for\nIBGP neighbors
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"install-diversion": "null", Install diversion path to RIB/CEF
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"attribute-filter-group-name": "string", Group name
{
"attribute-start": "string", Start of attribute range
"attribute-end": "string", End of attribute range
"filter-action": "string" Filtering action
} ] } } ] },
"local-preference": "integer", Local Preference Value
"update-limit-process": "integer", Upper bound on update generation transient\nmemory usage for the process
"rpki-origin-as-validation-time": "integer", Prefix validation time (in seconds). Range \n: 5 - 60. Specify 0 to disable the timer
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"nsr": "boolean", TRUE to Enable non-stop routing\nsupportFALSE to Disable non-stop routing\nsupport
"disable-neighbor-logging": "null", Disable neighbor change logging
{
"interface-name": "string" Interface Name
} ] },
"read-only": "null", Allow duplicate table config and disable\nupdate generation
"graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR\ncapable peers
"graceful-reset": "null", Reset gracefully if configuration change\nforces a peer reset
"update-out-logging": "null", Enables logging of update generation events
"graceful-restart-time": "integer", Restart time advertised to neighbors
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"retain-routes": "boolean", Keep routes in RIB once BGP stops
"all-neighbors": "boolean" Also for neighbors without graceful\nmaintenance config
},
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"graceful-restart-purge-time": "integer", Time before stale routes are purged.
{
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"default-metric": "integer", Default metric
"update-error-handling-basic-ebgp-disable": "null", Inbound update basic error-handling for\nEBGP neighbors
"igp-loop-check": "null", Enable AS-path loop checking for iBGP peers
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"formatted-messages": "integer", Number of messages to be formatted per\nupdate group
"desynchronize": "boolean", TRUE to enable desynchronization, FALSE\notherwise.
"enqueued-messages": "integer" Number of messages that can be enqueued in\ntotal
},
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
}, {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null" Enter Graceful Maintenance mode to configure\nparametrs
},
"enforce-ibgp-out-policy": "null", Allow all attributes to be modified by\noutbound policy for iBGP peers
{
"username": "string", RPKI server username
"password": "string", The neighbor password. Leave unspecified when\ndisabling the password.
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"response-time": "integer", RPKI server response-time (15-3600\nseconds)
"refresh-time": "integer", RPKI server refresh-time (15-3600\nseconds)
"server": "string", Server address (opaque string)
"shutdown": "null", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"purge-time": "integer", RPKI server purge-time (30-360 seconds)
"port": "string", port
"transport": "string" RPKI server transport
} } ] },
"delay": "integer", Delay value (seconds)
"always": "boolean" Set to TRUE to disable keepalive trigger\nbestpath and delay is enforced.
},
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
"keepalive": "integer" Keepalive interval (seconds)
},
"default-info-originate": "null", Control distribution of default information
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
"interval": "integer" Hello interval for BFD sessions created by BGP
},
"update-error-handling-basic-ibgp-disable": "null", Inbound update basic error-handling for\nIBGP neighbors
"next-hop-trigger-delay": "integer", Set the delay for triggering nexthop\nrecalculations
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
}, { {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"as-list-group-name": "string" Group name
} ] },
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"maximum-neighbors": "integer" Maximum number of neighbors that can be\nconfigured
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
{
"additional-paths-send": "string", Advertise additional paths Send capability
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"global-table-mcast": "null", Enable global table multicast
"update-limit-sub-group-ebgp": "integer", Upper bound on update generation\ntransient memory usage for every EBGP\nSub-group
"as": "string", AS number
"router-id": "string" Router ID
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
{
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"inter-as-install": "null", Enable install remote MVPN routes to PIM\nin default VRF
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"disable-client-to-client-rr": "null", Disable client-to-client reflection
{ {
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
} ],
"cluster-type": "string", Type of cluster-id
{
"cluster-id-number": "integer" Route-Reflector Cluster ID as 32 bit quantity
} ] } ] },
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"seconds": "integer", Delay, seconds part
"milliseconds": "integer" Delay, milliseconds part
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
"half-life": "integer", Half-life time for the penalty (minutes).
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
"suppress-threshold": "integer", Value to start suppressing a route.
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"implicit-import": "null", Implicit import configuration
"label-security-rpf": "null", Calculate label-security RPF lists and\ninstall to RIB/LSD
"use-igpsr-label": "null", Use IGP SR label for resolution\nconfiguration
"wait-rib-install": "null", Wait for route install before sending\nupdates to neighbors
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"next-hop-non-critical-trigger-delay": "integer", Next hop Non-critical Trigger Delay
"next-hop-critical-trigger-delay": "integer", Next hop Critical Trigger Delay
"label-retain": "integer", Label retention time in minutes
"seconds": "integer", Delay, seconds part
"milliseconds": "integer" Delay, milliseconds part
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
}, {
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"scan-time": "integer", Configure background scanner interval for\nthis address family
"external-routes": "integer", Distance for routes external to the AS
"local-routes": "integer", Distance for local routes
"internal-routes": "integer" Distance for routes internal to the AS
},
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
}, {
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
} ] },
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"table-policy": "string", Configure policy for installation of routes to\nRIB
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"source-rt-import-policy": "null" Enable sourcing of import route-targets \nfrom import-policy
},
"update-limit-sub-group-ibgp": "integer", Upper bound on update generation\ntransient memory usage for every IBGP\nSub-group
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"update-limit-address-family": "integer", Upper bound on update generation\ntransient memory usage for the\naddress-family
"default-metric": "string", Default metric
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"segmented-mcast": "null", Enable segmented multicast
"attribute-download": "null", Attribute download configuration
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"additional-paths-receive": "string", Advertise additional paths Receive capability
"next-hop-route-policy": "string", Next hop policy to filter out nexthop\nnotification
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"disable-default-martian-check": "null", Disable default Martian Check
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"af-name": "string", Address family
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"table-policy": "string", Configure policy for installation of routes to\nRIB
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"prefix-sid-map": "null" Retrieve prefix sid mapping from SRMS
} ] },
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"neighbor-logging-detail": "null", Include extra detail in neighbor change\nmessages
"update-error-handling-extended-ebgp": "null", Inbound update extended error-handling for\nEBGP neighbors
"global-scan-time": "integer", Configure background scanner interval for\ngeneric scanner
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"disable-enforce-first-as": "null", Disable enforce the first AS for EBGP routes
"graceful-restart": "null" Enable graceful restart support
}, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"prefix-length": "integer", Prefix length
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-group-name": "string", BGP neighbor group name
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"af-group-name": "string", BGP AF group name
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] } } ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"session-group-name": "string", BGP session group name
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FOUR-BYTE-AS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/

Create operation of resource: four-byte-as

four-byte-asbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

Request Content-Types: application/json
Request Example
{    
"bgp-running": "null", Enable BGP. Deletion of this object causes\ndeletion of all the objects under FourByteAS\nassociated with this object.
"as": "string", AS number
{
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
"half-life": "integer", Half-life time for the penalty (minutes).
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
"suppress-threshold": "integer", Value to start suppressing a route.
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
"local-routes": "integer", Distance for local routes
"internal-routes": "integer" Distance for routes internal to the AS
},
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
"keepalive": "integer" Keepalive interval (seconds)
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
"interval": "integer" Hello interval for BFD sessions created by BGP
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] },
"mvpn": "null", Connect to PIM/PIM6
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
{
"addrress": "string", Address
"as": "integer", AS number
"minimum": "integer", Minimum Prefix Length
"maximum": "integer" Maximum Prefix Length
} ] },
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"update-error-handling-extended-ibgp": "null", Inbound update extended error-handling for\nIBGP neighbors
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"install-diversion": "null", Install diversion path to RIB/CEF
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"attribute-filter-group-name": "string", Group name
{
"attribute-start": "string", Start of attribute range
"attribute-end": "string", End of attribute range
"filter-action": "string" Filtering action
} ] } } ] },
"local-preference": "integer", Local Preference Value
"update-limit-process": "integer", Upper bound on update generation transient\nmemory usage for the process
"rpki-origin-as-validation-time": "integer", Prefix validation time (in seconds). Range \n: 5 - 60. Specify 0 to disable the timer
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"nsr": "boolean", TRUE to Enable non-stop routing\nsupportFALSE to Disable non-stop routing\nsupport
"disable-neighbor-logging": "null", Disable neighbor change logging
{
"interface-name": "string" Interface Name
} ] },
"read-only": "null", Allow duplicate table config and disable\nupdate generation
"graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR\ncapable peers
"graceful-reset": "null", Reset gracefully if configuration change\nforces a peer reset
"update-out-logging": "null", Enables logging of update generation events
"graceful-restart-time": "integer", Restart time advertised to neighbors
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"retain-routes": "boolean", Keep routes in RIB once BGP stops
"all-neighbors": "boolean" Also for neighbors without graceful\nmaintenance config
},
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"graceful-restart-purge-time": "integer", Time before stale routes are purged.
{
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"default-metric": "integer", Default metric
"update-error-handling-basic-ebgp-disable": "null", Inbound update basic error-handling for\nEBGP neighbors
"igp-loop-check": "null", Enable AS-path loop checking for iBGP peers
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"formatted-messages": "integer", Number of messages to be formatted per\nupdate group
"desynchronize": "boolean", TRUE to enable desynchronization, FALSE\notherwise.
"enqueued-messages": "integer" Number of messages that can be enqueued in\ntotal
},
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
}, {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null" Enter Graceful Maintenance mode to configure\nparametrs
},
"enforce-ibgp-out-policy": "null", Allow all attributes to be modified by\noutbound policy for iBGP peers
{
"username": "string", RPKI server username
"password": "string", The neighbor password. Leave unspecified when\ndisabling the password.
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"response-time": "integer", RPKI server response-time (15-3600\nseconds)
"refresh-time": "integer", RPKI server refresh-time (15-3600\nseconds)
"server": "string", Server address (opaque string)
"shutdown": "null", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"purge-time": "integer", RPKI server purge-time (30-360 seconds)
"port": "string", port
"transport": "string" RPKI server transport
} } ] },
"delay": "integer", Delay value (seconds)
"always": "boolean" Set to TRUE to disable keepalive trigger\nbestpath and delay is enforced.
},
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
"keepalive": "integer" Keepalive interval (seconds)
},
"default-info-originate": "null", Control distribution of default information
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
"interval": "integer" Hello interval for BFD sessions created by BGP
},
"update-error-handling-basic-ibgp-disable": "null", Inbound update basic error-handling for\nIBGP neighbors
"next-hop-trigger-delay": "integer", Set the delay for triggering nexthop\nrecalculations
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
}, { {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"as-list-group-name": "string" Group name
} ] },
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"maximum-neighbors": "integer" Maximum number of neighbors that can be\nconfigured
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
{
"additional-paths-send": "string", Advertise additional paths Send capability
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"global-table-mcast": "null", Enable global table multicast
"update-limit-sub-group-ebgp": "integer", Upper bound on update generation\ntransient memory usage for every EBGP\nSub-group
"as": "string", AS number
"router-id": "string" Router ID
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
{
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"inter-as-install": "null", Enable install remote MVPN routes to PIM\nin default VRF
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"disable-client-to-client-rr": "null", Disable client-to-client reflection
{ {
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
} ],
"cluster-type": "string", Type of cluster-id
{
"cluster-id-number": "integer" Route-Reflector Cluster ID as 32 bit quantity
} ] } ] },
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"seconds": "integer", Delay, seconds part
"milliseconds": "integer" Delay, milliseconds part
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
"half-life": "integer", Half-life time for the penalty (minutes).
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
"suppress-threshold": "integer", Value to start suppressing a route.
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"implicit-import": "null", Implicit import configuration
"label-security-rpf": "null", Calculate label-security RPF lists and\ninstall to RIB/LSD
"use-igpsr-label": "null", Use IGP SR label for resolution\nconfiguration
"wait-rib-install": "null", Wait for route install before sending\nupdates to neighbors
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"next-hop-non-critical-trigger-delay": "integer", Next hop Non-critical Trigger Delay
"next-hop-critical-trigger-delay": "integer", Next hop Critical Trigger Delay
"label-retain": "integer", Label retention time in minutes
"seconds": "integer", Delay, seconds part
"milliseconds": "integer" Delay, milliseconds part
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
}, {
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"scan-time": "integer", Configure background scanner interval for\nthis address family
"external-routes": "integer", Distance for routes external to the AS
"local-routes": "integer", Distance for local routes
"internal-routes": "integer" Distance for routes internal to the AS
},
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
}, {
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
} ] },
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"table-policy": "string", Configure policy for installation of routes to\nRIB
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"source-rt-import-policy": "null" Enable sourcing of import route-targets \nfrom import-policy
},
"update-limit-sub-group-ibgp": "integer", Upper bound on update generation\ntransient memory usage for every IBGP\nSub-group
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"update-limit-address-family": "integer", Upper bound on update generation\ntransient memory usage for the\naddress-family
"default-metric": "string", Default metric
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"segmented-mcast": "null", Enable segmented multicast
"attribute-download": "null", Attribute download configuration
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"additional-paths-receive": "string", Advertise additional paths Receive capability
"next-hop-route-policy": "string", Next hop policy to filter out nexthop\nnotification
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"disable-default-martian-check": "null", Disable default Martian Check
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"af-name": "string", Address family
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"table-policy": "string", Configure policy for installation of routes to\nRIB
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"prefix-sid-map": "null" Retrieve prefix sid mapping from SRMS
} ] },
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"neighbor-logging-detail": "null", Include extra detail in neighbor change\nmessages
"update-error-handling-extended-ebgp": "null", Inbound update extended error-handling for\nEBGP neighbors
"global-scan-time": "integer", Configure background scanner interval for\ngeneric scanner
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"disable-enforce-first-as": "null", Disable enforce the first AS for EBGP routes
"graceful-restart": "null" Enable graceful restart support
}, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"prefix-length": "integer", Prefix length
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-group-name": "string", BGP neighbor group name
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"af-group-name": "string", BGP AF group name
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] } } ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"session-group-name": "string", BGP session group name
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FOUR-BYTE-AS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/

Delete operation of resource: four-byte-as

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

FOUR-BYTE-AS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/

Retrieve operation of resource: four-byte-as

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"bgp-running": "null", Enable BGP. Deletion of this object causes\ndeletion of all the objects under FourByteAS\nassociated with this object.
"as": "string", AS number
{
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
"half-life": "integer", Half-life time for the penalty (minutes).
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
"suppress-threshold": "integer", Value to start suppressing a route.
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
"local-routes": "integer", Distance for local routes
"internal-routes": "integer" Distance for routes internal to the AS
},
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
"keepalive": "integer" Keepalive interval (seconds)
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
"interval": "integer" Hello interval for BFD sessions created by BGP
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] },
"mvpn": "null", Connect to PIM/PIM6
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
{
"addrress": "string", Address
"as": "integer", AS number
"minimum": "integer", Minimum Prefix Length
"maximum": "integer" Maximum Prefix Length
} ] },
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"update-error-handling-extended-ibgp": "null", Inbound update extended error-handling for\nIBGP neighbors
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"install-diversion": "null", Install diversion path to RIB/CEF
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"attribute-filter-group-name": "string", Group name
{
"attribute-start": "string", Start of attribute range
"attribute-end": "string", End of attribute range
"filter-action": "string" Filtering action
} ] } } ] },
"local-preference": "integer", Local Preference Value
"update-limit-process": "integer", Upper bound on update generation transient\nmemory usage for the process
"rpki-origin-as-validation-time": "integer", Prefix validation time (in seconds). Range \n: 5 - 60. Specify 0 to disable the timer
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"nsr": "boolean", TRUE to Enable non-stop routing\nsupportFALSE to Disable non-stop routing\nsupport
"disable-neighbor-logging": "null", Disable neighbor change logging
{
"interface-name": "string" Interface Name
} ] },
"read-only": "null", Allow duplicate table config and disable\nupdate generation
"graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR\ncapable peers
"graceful-reset": "null", Reset gracefully if configuration change\nforces a peer reset
"update-out-logging": "null", Enables logging of update generation events
"graceful-restart-time": "integer", Restart time advertised to neighbors
"router-id": "string", Router ID
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"retain-routes": "boolean", Keep routes in RIB once BGP stops
"all-neighbors": "boolean" Also for neighbors without graceful\nmaintenance config
},
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"graceful-restart-purge-time": "integer", Time before stale routes are purged.
{
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"default-metric": "integer", Default metric
"update-error-handling-basic-ebgp-disable": "null", Inbound update basic error-handling for\nEBGP neighbors
"igp-loop-check": "null", Enable AS-path loop checking for iBGP peers
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"formatted-messages": "integer", Number of messages to be formatted per\nupdate group
"desynchronize": "boolean", TRUE to enable desynchronization, FALSE\notherwise.
"enqueued-messages": "integer" Number of messages that can be enqueued in\ntotal
},
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
}, {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null" Enter Graceful Maintenance mode to configure\nparametrs
},
"enforce-ibgp-out-policy": "null", Allow all attributes to be modified by\noutbound policy for iBGP peers
{
"username": "string", RPKI server username
"password": "string", The neighbor password. Leave unspecified when\ndisabling the password.
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"response-time": "integer", RPKI server response-time (15-3600\nseconds)
"refresh-time": "integer", RPKI server refresh-time (15-3600\nseconds)
"server": "string", Server address (opaque string)
"shutdown": "null", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"purge-time": "integer", RPKI server purge-time (30-360 seconds)
"port": "string", port
"transport": "string" RPKI server transport
} } ] },
"delay": "integer", Delay value (seconds)
"always": "boolean" Set to TRUE to disable keepalive trigger\nbestpath and delay is enforced.
},
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
"keepalive": "integer" Keepalive interval (seconds)
},
"default-info-originate": "null", Control distribution of default information
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
"interval": "integer" Hello interval for BFD sessions created by BGP
},
"update-error-handling-basic-ibgp-disable": "null", Inbound update basic error-handling for\nIBGP neighbors
"next-hop-trigger-delay": "integer", Set the delay for triggering nexthop\nrecalculations
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
}, { {
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"as-list-group-name": "string" Group name
} ] },
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"maximum-neighbors": "integer" Maximum number of neighbors that can be\nconfigured
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
{
"additional-paths-send": "string", Advertise additional paths Send capability
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"global-table-mcast": "null", Enable global table multicast
"update-limit-sub-group-ebgp": "integer", Upper bound on update generation\ntransient memory usage for every EBGP\nSub-group
"as": "string", AS number
"router-id": "string" Router ID
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
{
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"inter-as-install": "null", Enable install remote MVPN routes to PIM\nin default VRF
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"disable-client-to-client-rr": "null", Disable client-to-client reflection
{ {
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
} ],
"cluster-type": "string", Type of cluster-id
{
"cluster-id-number": "integer" Route-Reflector Cluster ID as 32 bit quantity
} ] } ] },
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"seconds": "integer", Delay, seconds part
"milliseconds": "integer" Delay, milliseconds part
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
"half-life": "integer", Half-life time for the penalty (minutes).
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
"suppress-threshold": "integer", Value to start suppressing a route.
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"implicit-import": "null", Implicit import configuration
"label-security-rpf": "null", Calculate label-security RPF lists and\ninstall to RIB/LSD
"use-igpsr-label": "null", Use IGP SR label for resolution\nconfiguration
"wait-rib-install": "null", Wait for route install before sending\nupdates to neighbors
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"next-hop-non-critical-trigger-delay": "integer", Next hop Non-critical Trigger Delay
"next-hop-critical-trigger-delay": "integer", Next hop Critical Trigger Delay
"label-retain": "integer", Label retention time in minutes
"seconds": "integer", Delay, seconds part
"milliseconds": "integer" Delay, milliseconds part
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
"all": "boolean", Whether all RTs are to be retained,\ndefault is FALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
}, {
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"rpki-bestpath-use-origin-as-validity": "null", RPKI bestpath use origin-AS validity
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"scan-time": "integer", Configure background scanner interval for\nthis address family
"external-routes": "integer", Distance for routes external to the AS
"local-routes": "integer", Distance for local routes
"internal-routes": "integer" Distance for routes internal to the AS
},
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
}, {
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
} ] },
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per\nCE label mode, per-vrf Set per VRF\nlabel mode
},
"rnh-install-format": "string", RNH install format type: extcomm -\ninstall rnh as opaque and extcomms,\nextcomm-only - install rnh as extcomms\nonly
"table-policy": "string", Configure policy for installation of routes to\nRIB
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"source-rt-import-policy": "null" Enable sourcing of import route-targets \nfrom import-policy
},
"update-limit-sub-group-ibgp": "integer", Upper bound on update generation\ntransient memory usage for every IBGP\nSub-group
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"update-limit-address-family": "integer", Upper bound on update generation\ntransient memory usage for the\naddress-family
"default-metric": "string", Default metric
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"segmented-mcast": "null", Enable segmented multicast
"attribute-download": "null", Attribute download configuration
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"additional-paths-receive": "string", Advertise additional paths Receive capability
"next-hop-route-policy": "string", Next hop policy to filter out nexthop\nnotification
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"disable-default-martian-check": "null", Disable default Martian Check
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
},
"af-name": "string", Address family
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"table-policy": "string", Configure policy for installation of routes to\nRIB
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
{
"default-metric": "string", Default metric
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"prefix-sid-map": "null" Retrieve prefix sid mapping from SRMS
} ] },
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"neighbor-logging-detail": "null", Include extra detail in neighbor change\nmessages
"update-error-handling-extended-ebgp": "null", Inbound update extended error-handling for\nEBGP neighbors
"global-scan-time": "integer", Configure background scanner interval for\ngeneric scanner
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"rpki-origin-as-validity-signal-ibgp": "null", RPKI origin-AS validity signal ibgp
"disable-enforce-first-as": "null", Disable enforce the first AS for EBGP routes
"graceful-restart": "null" Enable graceful restart support
}, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"prefix-length": "integer", Prefix length
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"neighbor-address": "string", Neighbor address
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
}, {
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-group-name": "string", BGP neighbor group name
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"neighbor-group-add-member": "string", Inherit configuration from a\nneighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] }, {
"af-group-name": "string", BGP AF group name
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"send-multicast-attr": "string", Config send multicast attribute for this\nneighbor
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
"stale-time-accept": "integer" Max time (seconds)
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this\naddress-family from an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"l2vpn-signalling": "string", Disable signalling type on the peer
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
"restart-time": "integer" Restart interval
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] } } ] }, {
"rpki-origin-as-validation-disable": "null", RPKI origin-AS validation disable
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
"minimum-interval": "integer" Minimum advertisement interval time, secs part
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"create": "null", Create this group. Deletion of this object\ncauses deletion of all the objects under\nNeighborGroup/SessionGroup associated with this\nobject.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
"session-group-add-member": "string", Inherit address-family independent config\nfrom a session-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
"bgp-receive-size": "integer" BGP read buffer size in bytes
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"rpki-bestpath-origin-as-allow-invalid": "null", RPKI bestpath origin-AS allow invalid
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
"socket-send-size": "integer" Send socket buffer size in bytes
},
"session-group-name": "string", BGP session group name
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
"keepalive-interval": "integer", Keepalive interval
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } } } }

VRFS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/

Update operation of resource: vrfs

vrfsbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

Request Content-Types: application/json
Request Example
{      {          
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Configure Router-id
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this address-family\nfrom an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config from a\nsession-group
"neighbor-group-add-member": "string", Inherit configuration from a neighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
range: "0..127"
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this address-family\nfrom an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config from a\nsession-group
"neighbor-group-add-member": "string", Inherit configuration from a neighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/

Create operation of resource: vrfs

vrfsbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

Request Content-Types: application/json
Request Example
{      {          
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Configure Router-id
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this address-family\nfrom an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config from a\nsession-group
"neighbor-group-add-member": "string", Inherit configuration from a neighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
range: "0..127"
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this address-family\nfrom an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config from a\nsession-group
"neighbor-group-add-member": "string", Inherit configuration from a neighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/

Delete operation of resource: vrfs

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/

Retrieve operation of resource: vrfs

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {          
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Configure Router-id
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this address-family\nfrom an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config from a\nsession-group
"neighbor-group-add-member": "string", Inherit configuration from a neighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
range: "0..127"
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this address-family\nfrom an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config from a\nsession-group
"neighbor-group-add-member": "string", Inherit configuration from a neighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] } }

VRF - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/

Update operation of resource: vrf

vrfbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{    {        
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Configure Router-id
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this address-family\nfrom an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config from a\nsession-group
"neighbor-group-add-member": "string", Inherit configuration from a neighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
range: "0..127"
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this address-family\nfrom an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config from a\nsession-group
"neighbor-group-add-member": "string", Inherit configuration from a neighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/

Create operation of resource: vrf

vrfbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{    {        
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Configure Router-id
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this address-family\nfrom an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config from a\nsession-group
"neighbor-group-add-member": "string", Inherit configuration from a neighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
range: "0..127"
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this address-family\nfrom an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config from a\nsession-group
"neighbor-group-add-member": "string", Inherit configuration from a neighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/

Delete operation of resource: vrf

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/

Retrieve operation of resource: vrf

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {        
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Configure Router-id
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name to specify criteria to\noriginate default.
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
},
"vrf-name": "string", VRF name
{
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this address-family\nfrom an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config from a\nsession-group
"neighbor-group-add-member": "string", Inherit configuration from a neighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"prefix-length": "integer", Prefix length
range: "0..127"
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ], {
"ignore-connected-check-ebgp": "boolean", TRUE to disable the connected nexthop check for\nthis peer.FALSE to enable the connected nexthop\ncheck for this peer.
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"idle-watch-time": "integer", Time to wait for deleteing IDLE state Dynamic\npeer
range: "30..1800"
units: "second"
"suppress-all-capabilities": "boolean", TRUE to suppress all capabilities. FALSE to not\nsuppress and to prevent inheritance from a\nparent
"shutdown": "boolean", TRUE to shutdown this entity, FALSE to prevent\nthis entity from being shutdown even if the\nparent is.
"max-peers": "integer", Set Maximum Peers in Dynamic Range
range: "1..4096"
"additional-paths-receive-capability": "string", Advertise additional paths Receive capability
"neighbor-graceful-restart-time": "integer", Restart time advertised to neighbor
range: "1..4095"
units: "second"
default: "120"
"description": "string", Up to 80 characters describing this neighbor
"minimum-interval-msecs": "integer", Minimum advertisement interval time, msecs part
range: "0..999"
units: "millisecond"
"minimum-interval": "integer" Minimum advertisement interval time, secs part
range: "0..600"
units: "second"
},
"replace-as": "null", Prepend only Local AS to announcements from\nthis neighbor
"dual-as": "null", Dual-AS mode
"no-prepend": "null", Do not prepend Local AS to announcements from\nthis neighbor
"as-xx": "string", xx of AS number xx.yy
"disable": "null", Disable Local AS and prevent it from being\ninherited from a parent
"as-yy": "string" yy of AS number xx.yy
},
"password-disable": "boolean", TRUE to prevent this entity from having a\npassword even if the parent has one. FALSEto\nspecify a password
"password": "string" The neighbor password. Leave unspecified when\ndisabling the password.
},
"keychain-name": "string", Name of the keychain associated with neighbor
"keychain-disable": "boolean" TRUE to prevent this entity from having a\nkeychain based authentication even if the\nparent has one.FALSE to specify a keychain name
},
"suppress-four-byte-as-capability": "boolean", TRUE to suppress BGP 4-byte-as capability.\nFALSE to not suppress it and to prevent\ninheritance from a parent
{
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"accept-route-legacy-rt": "boolean", TRUE to configure as a accept-route-legacy-RT.\nFALSE to prevent accept-route-legacy-RT from\nbeing inherited.
"enforce-multiple-labels": "boolean", TRUE to enforce multiple labels support.
"activate": "null", Activate an address family for this neighbor.\nDeletion of this object causes deletion of all\nthe objects under\nNeighborAF/VRFNeighborAF/NeighborGroupAF\nassociated with this object.
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"advertise-orf": "string", Advertise ORF capability to the peer
"flowspec-validation": "string", Config Flowspec validation for this neighbor
"accept-own": "boolean", Handle self-originated routes with Accept-Own\ncommunity. Valid for following neighbor\naddress-families: VPNv4Unicast, VPNv6Unicast.
"route-reflector-client": "boolean", TRUE to configure as a route-reflector-client.\nFALSE to prevent route-reflector-client from\nbeing inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"route-policy-name": "string" Route policy name to specify criteria to\noriginate default.
},
"send-community-ebgp-graceful-shutdown": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"advertise-local-labeled-route": "string", Enable/disable advertisement of routes with\nlocal-label
"multipath": "null", Allow paths from this neighbor to be eligible\nfor selective multipath
"aigp-send-med": "string", Enable/Disable sending AIGP in MED
"af-name": "string", Address family
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"as-override": "boolean", TRUE to override matching AS-number while\nsending update. FALSE to prevent as-override\nfrom being inherited from the parent
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"next-hop-self": "boolean", Disable the next hop calculation and insert\nyour own address in the nexthop field of\nadvertised routes you learned from the neighbor.
"neighbor-af-long-lived-graceful-restart-capable": "boolean", TRUE to treat neighbor as Long-lived\nGraceful-restart capable. FALSE to rely on\ncapability negotiation.
"send-community-ebgp": "boolean", TRUE to send communities to the external\nneighbor/neighbor-group/af-group. FALSE not to\nsend and to prevent inheritance from a parent
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"stale-time-send": "integer", Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
"stale-time-accept": "integer" Max time (seconds)
range: "0..16777215"
units: "second"
default: "0"
},
"import-reoriginate": "boolean", TRUE to Reoriginate imported routes, FALSE to\nnot Reoriginate imported routes - not supported
"import-stitching": "boolean", TRUE to Import with Stitching RTs, FALSE to\nImport with normal RTs
"import-reoriginate-stitching": "boolean" TRUE to Reoriginate imported routes with\nStitching RTs, FALSE to Reoriginate imported\nroutes with normal RTs
},
"af-group": "string", Inherit configuration for this address-family\nfrom an AF-group
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"default-weight": "integer", Set default weight for routes from this\nneighbor/neighbor-group/af-group
range: "0..65535"
"optimal-route-reflection-group": "string", Name of the ORR group this neighbor is going to\nbe part of
"route-policy-in": "string", Route policy name to apply to inbound routes
"prefix-orf-policy": "string", Prefix ORF policy name for incoming updates
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"af-name": "string", Address family
"rt-type": "string", RT type
"adv-option": "string" Advertise option
},
"next-hop-unchanged-multipath": "boolean", TRUE to disable overwriting of next hop for\nmultipaths. FALSE to prevent next-hop-unchanged\nfor multipaths.
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"entire": "boolean", TRUE to remove private AS from inbound updates\nif all ASes in aspath areprivate. FALSE to\nprevent remove-private-ASfrom being inherited.
"enable": "boolean" Enter Graceful Maintenance mode to configure\nparametrs
},
"send-ext-community-ebgp": "boolean", TRUE to send extended communities to the\nexternal neighbor/neighbor-group/af-group.\nFALSE not to send and to prevent inheritance\nfrom a parent
"as-index": "string", AS number Index
"address-index": "string", IP address Index
"as-xx": "string", xx of AS number xx.yy
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Set type of service
},
"discard-extra-paths": "boolean", Discard extra paths when limit is exceeded
"warning-percentage": "integer", Threshold value (%) at which to generate a\nwarning message.
range: "1..100"
default: "75"
"warning-only": "boolean", TRUE to only give a warning message when limit\nis exceeded. FALSE to accept max prefix limit\nonly.
"prefix-limit": "integer", Maximum prefixes limit
range: "1..4294967295"
"restart-time": "integer" Restart interval
range: "0..65535"
default: "0"
},
"aigp": "string", Enable Accumulated IGP Metric for this neighbor.
"route-policy-out": "string", Route policy name to apply to outbound routes
"af-name": "string", Address family
"rt-type": "string", RT type
"reorg-option": "string" Reorigination option
},
"encapsulation-type": "string", Encapsulation type for this neighbor
"next-hop-unchanged": "boolean", TRUE to disable overwriting of next hop before\nadvertising to eBGP peers. FALSE to prevent\nnext-hop-unchanged from being inherited.
"enable": "boolean", Enter Graceful Maintenance mode to configure\nparametrs
"cost-community-poi-type": "string", Cost Community POI
"cost-community-id": "integer", Cost Community ID
range: "0..255"
"transitive": "boolean" True to send transitive cost community FALSE\notherwise
},
"advertise-permanent-network": "null", Advertise Permanent Networks to the peer
"allow-as-in": "integer", Allow as-path with my AS present in it
range: "1..10"
default: "3"
"soft-always": "boolean", TRUE to always use soft reconfig, even if route\nrefresh is supported. FALSE otherwise.
"inbound-soft": "boolean" FALSE to prohibit inbound soft reconfiguration.\nTRUE otherwise.
} } ] },
"neighbor-graceful-restart": "string", TRUE to Enable graceful restart supportfor\nneighbor. FALSE to disable graceful restart\nsupport for neighbor.
"ttl-security": "boolean", TRUE to enable BGP TTL Security. FALSE to not\nenable it and to prevent inheritance from a\nparent
"propagate-dmz-link-bandwidth": "boolean", TRUE to propagate DMZ link bandwidth. FALSE to\nnot propagate and to prevent inheritance from a\nparent
"msg-log-inherit-disable": "boolean", TRUE, to prevent this entity from having a\noutbound message logging if parent has one
"msg-log-disable": "boolean", Disable inbound message logging
"msg-buf-count": "integer" Outbound message log buffer size
range: "1..100"
},
"remote-as-list": "string", Remote-as-list group name
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"number-of-buffers": "integer", Number of message buffers
range: "0..25"
"non-circular-buffer": "boolean" TRUE to configure non-circular buffer
},
"update-in-filtering-syslog-disable": "null", Disable inbound update filtering syslog\nmessages
"update-in-filtering-attribute-filter-group": "string" Attribute-filter group name for update\nfiltering
},
"ebgp-send-dmz-enable-modes": "string", Default mode, Cumulative mode or Disable to\nprevent inheritance from a parent
"enable": "null", Enter Graceful Maintenance mode to configure\nparametrs
"local-preference": "integer", Local Preference Value
range: "0..4294967295"
default: local preference"
"gshut-loc-pref-disable": "boolean" TRUE, to prevent inheritance of Local Pref\nvalue from its parents.FALSE, otherwise
},
"graceful-maintenance-activate": "boolean", Initiate the graceful shutdown procedure
"gshut-prepends-disable": "boolean", TRUE, to prevent inheritance of AS Prepends\nvalue from its parents.FALSE, otherwise
"as-prepends": "integer" number of times AS prepends
range: "0..6"
} },
"internal-vpn-client-ibgp-ce": "boolean", TRUE to preserve the CE path attributes.FALSE to\noverride CE path attributes.
"enforce-first-as": "boolean", TRUE to enforce first AS; FALSE to not enforce\nfirst AS.
"additional-paths-send-capability": "string", Advertise additional paths Send capability
"local-address-disable": "boolean", TRUE to prevent this entity from having a local\naddress if the parent has one.FALSE to specify\nlocal ip address
"local-ip-address": "string" Local ip address for neighbor
},
"neighbor-graceful-restart-stalepath-time": "integer", Maximum time to wait for restart of GR capable\npeer
range: "1..4095"
units: "second"
default: "360"
"bfd-multiplier": "integer", Detection multiplier for BFD sessions created by\nBGP
range: "2..16"
"session-group-add-member": "string", Inherit address-family independent config from a\nsession-group
"neighbor-group-add-member": "string", Inherit configuration from a neighbor-group
"ebgp-recv-dmz": "boolean", TRUE to receive DMZ link bandwidth from ebgp\npeer. FALSE to not receive from ebgp peer and to\nprevent inheritance from a parent
{
"server-id": "integer" BMP Server ID
range: "1..8"
} ] },
"session-open-mode": "string", TCP mode to be used to establish BGP session
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"bfd-minimum-interval": "integer", Hello interval for BFD sessions created by BGP
range: "3..30000"
units: "millisecond"
"cluster-id-number": "integer", Route-Reflector Cluster ID as 32 bit quantity
range: "0..4294967295"
"cluster-id-address": "string" Route-Reflector Cluster ID in IPV4 address\nformat
},
"as-xx": "string", xx of AS number xx.yy
"as-yy": "string" yy of AS number xx.yy
},
"neighbor-address": "string", Neighbor address
"egress-peer-engineering": "boolean", TRUE to enable egress peer engineering FALSE to\ndisable egress peer engineering and to prevent\ninheritance from a parent
"bgp-send-size": "integer", BGP write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"tcpmss-disable": "boolean", TRUE, to prevent inheritance ofTCP MSS\nvaluefrom its parents.FALSE, otherwise
"mss": "integer" Maximum Segment Size
range: "68..10000"
},
"min-accept-hold-time": "integer", Minimum acceptable hold time. Specify 0 to\ndisable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"keepalive-interval": "integer", Keepalive interval
range: "0..65535"
default: "60"
"hold-time": "integer" Hold time. Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
},
"type": "string", Set type of service
"value": "string" TOS value to set
},
"max-hop-count": "integer", Maximum hop count
range: "1..255"
default: "255"
"mpls-deactivation": "boolean" TRUE to not enable MPLS and NULL rewrite.
},
"update-source-interface": "string", Select an interface to configure
"bfd-enable-modes": "string" Strict mode, Default mode or Disable to prevent\ninheritance from a parent
} ] } } ] }

VRF-GLOBAL - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/

Update operation of resource: vrf-global

vrf-globalbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{    
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP Read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Configure default local preference
range: "0..4294967295"
default: local preference"
"as-index": "string", ASN Index
"address-index": "string", IP address index
"as-xx": "string", AS number
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Type of RD
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Configure Router-id
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enable the address family. Deletion of this\nobject causes deletion of all the objects under\nGlobalAF/VRFGlobalAF associated with this object\n.
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time (seconds). Specify\n0 to disable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time (seconds). Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP Write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/

Create operation of resource: vrf-global

vrf-globalbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{    
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP Read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Configure default local preference
range: "0..4294967295"
default: local preference"
"as-index": "string", ASN Index
"address-index": "string", IP address index
"as-xx": "string", AS number
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Type of RD
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Configure Router-id
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enable the address family. Deletion of this\nobject causes deletion of all the objects under\nGlobalAF/VRFGlobalAF associated with this object\n.
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time (seconds). Specify\n0 to disable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time (seconds). Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP Write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/

Delete operation of resource: vrf-global

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/

Retrieve operation of resource: vrf-global

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"exists": "null", Create this VRF. Deletion of this object\ncauses deletion of all the objects under\nVRF associated with this object.
"socket-receive-size": "integer", Receive socket buffer size in bytes
range: "512..131072"
units: "byte"
default: "32768"
"bgp-receive-size": "integer" BGP Read buffer size in bytes
range: "512..131072"
units: "byte"
default: "4096"
},
"best-path-router-id": "null", Change default route selection criteria and\ncompare router-id for identical EBGP paths
"disable-fast-external-fallover": "null", Disable immediate reset session if a link to a\ndirectly connected external peer goes down
"best-path-cost-community": "null", Change default route selection criteria to\nignore cost community comparison
"local-preference": "integer", Configure default local preference
range: "0..4294967295"
default: local preference"
"as-index": "string", ASN Index
"address-index": "string", IP address index
"as-xx": "string", AS number
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Type of RD
},
"disable-auto-soft-reset": "null", Disable automatic soft peer reset on policy\nreconfiguration
{
"interface-name": "string" Interface Name
} ] },
"disable-neighbor-logging": "null", Disable neighbor change logging
"igp-redist-internal": "null", Allow redistribution of iBGP into IGPs\n(dangerous)
"default-metric": "integer", Default metric
range: "1..4294967295"
"disable-msg-log": "null", Disable inbound and outbound messagelogging for\nall neighbors under the vrf
"router-id": "string", Configure Router-id
"multi-path-as-path-ignore-onwards": "null", Change default multi-route selection criteria to\nignore everything onwards as-path check
"unsafe-ebgp-policy": "null", If eBGP neighbor is configured without a\nroute-policy,the routes from that neighbor are\nnot accepted by default.This knob overrides the\ndefault behavior. When configured,routes from\nthe eBGP neighbors with no policy are accepted.
"best-path-med-always": "null", Change default route selection criteria and\nallow comparing of MED from different neighbors
"best-path-confederation-paths": "null", Change default route selection criteria and\nallow the comparing of MED among confederation\npaths
"best-path-as-path-length": "null", Change default route selection criteria to\nignore AS path length
{
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enable the address family. Deletion of this\nobject causes deletion of all the objects under\nGlobalAF/VRFGlobalAF associated with this object\n.
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] },
"min-accept-hold-time": "integer", Minimum acceptable hold time (seconds). Specify\n0 to disable keepalives/hold time
range: "0..65535"
units: "second"
default: "3"
"hold-time": "integer", Hold time (seconds). Specify 0 to disable\nkeepalives/hold time
range: "0..65535"
units: "second"
default: "180"
"keepalive": "integer" Keepalive interval (seconds)
range: "0..65535"
units: "second"
default: "60"
},
"default-info-originate": "null", Control distribution of default information
"bgp-send-size": "integer", BGP Write buffer size in bytes
range: "4096..131072"
units: "byte"
default: "4096"
"socket-send-size": "integer" Send socket buffer size in bytes
range: "4096..131072"
units: "byte"
default: "24576"
},
"next-hop-mpls-fwd-ibgp": "null", Enable mpls forwarding path for ibgp learnt\nnexthops
"best-path-as-multipath-relax": "null", Change default multi-route selection criteria to\nrelax as-path checking - only require same\naspath length
"best-path-aigp-ignore": "null", Change default route selection criteria to\nignore AIGP unless both paths whichare compared\nhave AIGP attribute
"detection-multiplier": "integer", Detection multiplier for BFD sessions created\nby BGP
range: "2..16"
"interval": "integer" Hello interval for BFD sessions created by BGP
units: "millisecond"
},
"best-path-med-missing": "null", Treat missing MED as the least preferred one
"disable-enforce-first-as": "null" Disable enforce the first AS for EBGP routes
} }

ROUTE-DISTINGUISHER - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/route-distinguisher/

Update operation of resource: route-distinguisher

route-distinguisherbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{    
"as-index": "string", ASN Index
"address-index": "string", IP address index
"as-xx": "string", AS number
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Type of RD
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-DISTINGUISHER - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/route-distinguisher/

Create operation of resource: route-distinguisher

route-distinguisherbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{    
"as-index": "string", ASN Index
"address-index": "string", IP address index
"as-xx": "string", AS number
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Type of RD
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-DISTINGUISHER - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/route-distinguisher/

Delete operation of resource: route-distinguisher

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROUTE-DISTINGUISHER - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/route-distinguisher/

Retrieve operation of resource: route-distinguisher

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"as-index": "string", ASN Index
"address-index": "string", IP address index
"as-xx": "string", AS number
"as": "string", AS number
range: "1..4294967295"
"address": "string", IP address
"type": "string" Type of RD
} }

VRF-GLOBAL-AFS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/

Update operation of resource: vrf-global-afs

vrf-global-afsbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{      {
        
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enable the address family. Deletion of this\nobject causes deletion of all the objects under\nGlobalAF/VRFGlobalAF associated with this object\n.
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL-AFS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/

Create operation of resource: vrf-global-afs

vrf-global-afsbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

Request Content-Types: application/json
Request Example
{      {
        
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enable the address family. Deletion of this\nobject causes deletion of all the objects under\nGlobalAF/VRFGlobalAF associated with this object\n.
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL-AFS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/

Delete operation of resource: vrf-global-afs

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL-AFS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/

Retrieve operation of resource: vrf-global-afs

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enable the address family. Deletion of this\nobject causes deletion of all the objects under\nGlobalAF/VRFGlobalAF associated with this object\n.
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] } }

VRF-GLOBAL-AF - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/

Update operation of resource: vrf-global-af

vrf-global-afbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    {
      
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enable the address family. Deletion of this\nobject causes deletion of all the objects under\nGlobalAF/VRFGlobalAF associated with this object\n.
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL-AF - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/

Create operation of resource: vrf-global-af

vrf-global-afbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    {
      
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enable the address family. Deletion of this\nobject causes deletion of all the objects under\nGlobalAF/VRFGlobalAF associated with this object\n.
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL-AF - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/

Delete operation of resource: vrf-global-af

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-GLOBAL-AF - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/

Retrieve operation of resource: vrf-global-af

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"additional-paths-send": "string", Advertise additional paths Send capability
"single-forwarder-selection": "string" Select MVPN single forwarder selection
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] },
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
}, {
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] },
"enable": "null", Enable the address family. Deletion of this\nobject causes deletion of all the objects under\nGlobalAF/VRFGlobalAF associated with this object\n.
"best-external": "boolean", TRUE to enable BE FALSE to disable BE\ninheritance from a parent
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"all": "boolean", Whether all nets should be labeled, default is\nFALSE
"route-policy-name": "string" Route policy name
},
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"advertise-local-labeled-route-safi-unicast": "string", Enable/disable advertisement of routes with\nlocal-label via Unicast SAFI
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] },
"permanent-network": "string", Route policy for permanent networks
"disable-as-path-loop-check": "null", Disable outbound AS Path loop check
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"dynamic-med-interval": "integer", Update generation delay (in minutes) after a MED\nchange
range: "0..10"
units: "minute"
default: "10"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", EIGRP router tag
"not-used": "integer" Not used
range: "0..127"
} ] },
"reset-weight-on-import": "boolean", TRUE to reset weight on import. FALSE to not\nreset and to prevent inheritance from a parent
"route-policy-name": "string", Route policy name
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
},
"table-policy": "string", Configure policy for installation of routes to\nRIB
"selection": "string", Enable/disable selection
"route-policy-name": "string" Route policy name
},
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name
},
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
},
"attribute-download": "null", Attribute download configuration
"rt-download": "null", Route-Target download configuration
"additional-paths-receive": "string", Advertise additional paths Receive capability
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
},
"af-name": "string", Address family
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP\nmetric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}, {
"route-policy-name": "string", Route policy name
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] },
"allow-vpn-default-originate": "boolean", TRUE to send default orig route to VPN\nneighborFALSE to not send default\noriginate route
"next-hop-resolution-prefix-length-minimum": "integer", Minimum prefix-length for nexthop resolution
range: "0..128"
default: "0"
{
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } } ] }

MVPN - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/mvpn/

Update operation of resource: mvpn

mvpnbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"single-forwarder-selection": "string" Select MVPN single forwarder selection
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MVPN - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/mvpn/

Create operation of resource: mvpn

mvpnbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"single-forwarder-selection": "string" Select MVPN single forwarder selection
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MVPN - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/mvpn/

Delete operation of resource: mvpn

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MVPN - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/mvpn/

Retrieve operation of resource: mvpn

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"single-forwarder-selection": "string" Select MVPN single forwarder selection
} }

EBGP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ebgp/

Update operation of resource: ebgp

ebgpbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ebgp/

Create operation of resource: ebgp

ebgpbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ebgp/

Delete operation of resource: ebgp

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EBGP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ebgp/

Retrieve operation of resource: ebgp

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
} }

EIBGP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eibgp/

Update operation of resource: eibgp

eibgpbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIBGP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eibgp/

Create operation of resource: eibgp

eibgpbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIBGP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eibgp/

Delete operation of resource: eibgp

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIBGP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eibgp/

Retrieve operation of resource: eibgp

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
} }

IBGP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ibgp/

Update operation of resource: ibgp

ibgpbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{  
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IBGP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ibgp/

Create operation of resource: ibgp

ibgpbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{  
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IBGP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ibgp/

Delete operation of resource: ibgp

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IBGP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/ibgp/

Retrieve operation of resource: ibgp

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{  
"order-by-igp-metric": "boolean", Order candidate multipaths by IGP metric
"paths-value": "integer", Number of paths
range: "2..64"
"selective": "boolean", Allow multipaths only from marked\nneighbors
"unequal-cost": "boolean" UNUSED
}

AGGREGATE-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/

Update operation of resource: aggregate-addresses

aggregate-addressesbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{      {
        
"route-policy-name": "string", Route policy on which to condition\nadvertisement, suppression, and attributes
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/

Create operation of resource: aggregate-addresses

aggregate-addressesbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{      {
        
"route-policy-name": "string", Route policy on which to condition\nadvertisement, suppression, and attributes
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/

Delete operation of resource: aggregate-addresses

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/

Retrieve operation of resource: aggregate-addresses

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"route-policy-name": "string", Route policy on which to condition\nadvertisement, suppression, and attributes
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] } }

AGGREGATE-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/aggregate-address/{aggregate-addr aggregate-prefix}/

Update operation of resource: aggregate-address

aggregate-addressbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

aggregate-addr aggregate-prefix: string
in path

ID of aggregate-addr aggregate-prefix

Request Content-Types: application/json
Request Example
{    {
      
"route-policy-name": "string", Route policy on which to condition\nadvertisement, suppression, and attributes
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/aggregate-address/{aggregate-addr aggregate-prefix}/

Create operation of resource: aggregate-address

aggregate-addressbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

aggregate-addr aggregate-prefix: string
in path

ID of aggregate-addr aggregate-prefix

Request Content-Types: application/json
Request Example
{    {
      
"route-policy-name": "string", Route policy on which to condition\nadvertisement, suppression, and attributes
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/aggregate-address/{aggregate-addr aggregate-prefix}/

Delete operation of resource: aggregate-address

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

aggregate-addr aggregate-prefix: string
in path

ID of aggregate-addr aggregate-prefix

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGGREGATE-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/aggregate-addresses/aggregate-address/{aggregate-addr aggregate-prefix}/

Retrieve operation of resource: aggregate-address

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

aggregate-addr aggregate-prefix: string
in path

ID of aggregate-addr aggregate-prefix

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"route-policy-name": "string", Route policy on which to condition\nadvertisement, suppression, and attributes
"aggregate-prefix": "integer", Aggregate in prefix/length format (prefix\npart)
range: "0..128"
"summary-only": "boolean", TRUE to filter more specific routes from\nupdates, FALSEotherwise
"generate-set-info": "boolean", TRUE to generate AS set path information,\nFALSE otherwise
"generate-confederation-set-info": "boolean", TRUE to generate AS confederation set path\ninformation, FALSE otherwise
"aggregate-addr": "string" Aggregate in prefix/length format (address\npart)
} ] }

OPTIMAL-ROUTE-REFLECTOR-GROUPS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/optimal-route-reflector-groups/

Update operation of resource: optimal-route-reflector-groups

optimal-route-reflector-groupsbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{      {
        
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUPS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/optimal-route-reflector-groups/

Create operation of resource: optimal-route-reflector-groups

optimal-route-reflector-groupsbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{      {
        
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUPS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/optimal-route-reflector-groups/

Delete operation of resource: optimal-route-reflector-groups

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUPS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/optimal-route-reflector-groups/

Retrieve operation of resource: optimal-route-reflector-groups

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] } }

OPTIMAL-ROUTE-REFLECTOR-GROUP - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/optimal-route-reflector-groups/optimal-route-reflector-group/{group-name}/

Update operation of resource: optimal-route-reflector-group

optimal-route-reflector-groupbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

group-name: string
in path

ID of group-name

Request Content-Types: application/json
Request Example
{    {
      
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUP - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/optimal-route-reflector-groups/optimal-route-reflector-group/{group-name}/

Create operation of resource: optimal-route-reflector-group

optimal-route-reflector-groupbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

group-name: string
in path

ID of group-name

Request Content-Types: application/json
Request Example
{    {
      
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUP - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/optimal-route-reflector-groups/optimal-route-reflector-group/{group-name}/

Delete operation of resource: optimal-route-reflector-group

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

group-name: string
in path

ID of group-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OPTIMAL-ROUTE-REFLECTOR-GROUP - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/optimal-route-reflector-groups/optimal-route-reflector-group/{group-name}/

Retrieve operation of resource: optimal-route-reflector-group

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

group-name: string
in path

ID of group-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"primary-root-address": "string", Primary Root for the ORR group
"group-name": "string", Name of the ORR group
"tertiary-root-address": "string", Tertiary Root for the ORR group
"secondary-root-address": "string" Secondary Root for the ORR group
} ] }

DAMPENING - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/dampening/

Update operation of resource: dampening

dampeningbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy to specify criteria for dampening.\nThis cannot be specified if any other\nparameters are specified.
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/dampening/

Create operation of resource: dampening

dampeningbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy to specify criteria for dampening.\nThis cannot be specified if any other\nparameters are specified.
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/dampening/

Delete operation of resource: dampening

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DAMPENING - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/dampening/

Retrieve operation of resource: dampening

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"reuse-threshold": "integer", Value to start reusing a route.
range: "1..20000"
"half-life": "integer", Half-life time for the penalty (minutes).
range: "1..45"
units: "minute"
"suppress-time": "integer", Maximum duration to suppress a stable route\n(seconds).
range: "1..255"
units: "second"
"suppress-threshold": "integer", Value to start suppressing a route.
range: "1..20000"
"route-policy-name": "string" Route policy to specify criteria for dampening.\nThis cannot be specified if any other\nparameters are specified.
} }

RIP-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/rip-routes/

Update operation of resource: rip-routes

rip-routesbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RIP-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/rip-routes/

Create operation of resource: rip-routes

rip-routesbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RIP-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/rip-routes/

Delete operation of resource: rip-routes

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RIP-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/rip-routes/

Retrieve operation of resource: rip-routes

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
} }

LISP-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/lisp-routes/

Update operation of resource: lisp-routes

lisp-routesbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LISP-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/lisp-routes/

Create operation of resource: lisp-routes

lisp-routesbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LISP-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/lisp-routes/

Delete operation of resource: lisp-routes

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LISP-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/lisp-routes/

Retrieve operation of resource: lisp-routes

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string" Route policy name
} }

STATIC-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/static-routes/

Update operation of resource: static-routes

static-routesbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/static-routes/

Create operation of resource: static-routes

static-routesbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/static-routes/

Delete operation of resource: static-routes

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

STATIC-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/static-routes/

Retrieve operation of resource: static-routes

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"not-used": "integer" Not used
range: "0..127"
} }

DISTANCE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/distance/

Update operation of resource: distance

distancebody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISTANCE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/distance/

Create operation of resource: distance

distancebody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISTANCE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/distance/

Delete operation of resource: distance

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DISTANCE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/distance/

Retrieve operation of resource: distance

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"external-routes": "integer", Distance for routes external to the AS
range: "1..255"
default: "20"
"local-routes": "integer", Distance for local routes
range: "1..255"
default: "200"
"internal-routes": "integer" Distance for routes internal to the AS
range: "1..255"
default: "200"
} }

APPLICATION-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/

Update operation of resource: application-routes

application-routesbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{      {
        
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", OnePK application name
"not-used": "integer" Not used
range: "0..127"
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/

Create operation of resource: application-routes

application-routesbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{      {
        
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", OnePK application name
"not-used": "integer" Not used
range: "0..127"
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/

Delete operation of resource: application-routes

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/

Retrieve operation of resource: application-routes

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", OnePK application name
"not-used": "integer" Not used
range: "0..127"
} ] } }

APPLICATION-ROUTE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/application-route/{instance-name}/

Update operation of resource: application-route

application-routebody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

instance-name: string
in path

ID of instance-name

Request Content-Types: application/json
Request Example
{    {
      
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", OnePK application name
"not-used": "integer" Not used
range: "0..127"
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/application-route/{instance-name}/

Create operation of resource: application-route

application-routebody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

instance-name: string
in path

ID of instance-name

Request Content-Types: application/json
Request Example
{    {
      
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", OnePK application name
"not-used": "integer" Not used
range: "0..127"
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/application-route/{instance-name}/

Delete operation of resource: application-route

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

instance-name: string
in path

ID of instance-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLICATION-ROUTE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/application-routes/application-route/{instance-name}/

Retrieve operation of resource: application-route

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

instance-name: string
in path

ID of instance-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"instance-name": "string", OnePK application name
"not-used": "integer" Not used
range: "0..127"
} ] }

LABEL-MODE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/label-mode/

Update operation of resource: label-mode

label-modebody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"route-policy-name": "string", Label mode route policy name
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-MODE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/label-mode/

Create operation of resource: label-mode

label-modebody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{    
"route-policy-name": "string", Label mode route policy name
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-MODE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/label-mode/

Delete operation of resource: label-mode

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LABEL-MODE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/label-mode/

Retrieve operation of resource: label-mode

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"route-policy-name": "string", Label mode route policy name
"label-allocation-mode": "string" Label allocation mode: per-ce Set per CE label\nmode, per-vrf Set per VRF label mode,\nper-prefix Set per Prefix label mode (for\nMPLS-VPN only)
} }

EIGRP-ROUTES - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eigrp-routes/

Update operation of resource: eigrp-routes

eigrp-routesbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{      {
        
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTES - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eigrp-routes/

Create operation of resource: eigrp-routes

eigrp-routesbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{      {
        
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTES - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eigrp-routes/

Delete operation of resource: eigrp-routes

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTES - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eigrp-routes/

Retrieve operation of resource: eigrp-routes

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] } }

EIGRP-ROUTE - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eigrp-routes/eigrp-route/{instance-name}/

Update operation of resource: eigrp-route

eigrp-routebody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

instance-name: string
in path

ID of instance-name

Request Content-Types: application/json
Request Example
{    {
      
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTE - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eigrp-routes/eigrp-route/{instance-name}/

Create operation of resource: eigrp-route

eigrp-routebody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

instance-name: string
in path

ID of instance-name

Request Content-Types: application/json
Request Example
{    {
      
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTE - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eigrp-routes/eigrp-route/{instance-name}/

Delete operation of resource: eigrp-route

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

instance-name: string
in path

ID of instance-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

EIGRP-ROUTE - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/eigrp-routes/eigrp-route/{instance-name}/

Retrieve operation of resource: eigrp-route

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

instance-name: string
in path

ID of instance-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"default-metric": "string", Default metric
range: "1..4294967295"
"route-policy-name": "string", Route policy name
"redist-type": "string", Redistribution type: 01 for internal routes,\n02 for external routes, Logical combinations\npermitted.
"instance-name": "string" EIGRP router tag
} ] }

SOURCED-NETWORKS - Update

PUT Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/sourced-networks/

Update operation of resource: sourced-networks

sourced-networksbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{      {
        
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORKS - Create

POST Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/sourced-networks/

Create operation of resource: sourced-networks

sourced-networksbody object

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Request Content-Types: application/json
Request Example
{      {
        
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORKS - Delete

DELETE Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/sourced-networks/

Delete operation of resource: sourced-networks

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SOURCED-NETWORKS - Retrieve

GET Cisco-IOS-XR-ipv4-bgp-cfg:bgp/instance/{instance-name}/instance-as/{as}/four-byte-as/{our-byte-as_as}/vrfs/vrf/{vrf-name}/vrf-global/vrf-global-afs/vrf-global-af/{af-name}/sourced-networks/

Retrieve operation of resource: sourced-networks

instance-name: string
in path

ID of instance-name

as: string
in path

ID of as

our-byte-as_as: string
in path

ID of our-byte-as_as

vrf-name: string
in path

ID of vrf-name

af-name: string
in path

ID of af-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"network-prefix": "integer", Network in prefix/length format (prefix part)
range: "0..128"
"route-policy-name": "string", Route policy name
"network-addr": "string", Network in prefix/length format (address part)
"backdoor": "boolean" Specify a BGP backdoor route, default is FALSE
} ] } }